Module bus.gitlab

Package org.miaixz.bus.gitlab

Class KeysApi

java.lang.Object

org.miaixz.bus.gitlab.AbstractApi

org.miaixz.bus.gitlab.KeysApi

All Implemented Interfaces:

Constants

public class KeysApi
extends AbstractApi

See: GitLab Key API Documentaion

Nested Class Summary

Nested classes/interfaces inherited from interface org.miaixz.bus.gitlab.models.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoCancelPendingPipelines, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DefaultBranchProtectionLevel, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope<T>, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.PipelineSource, Constants.ProjectAccessTokenScope, Constants.ProjectCreationLevel, Constants.ProjectFeatureVisibilityAccessLevel, Constants.ProjectOrderBy, Constants.ProjectSearchScope<T>, Constants.SearchScope<T>, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.SubgroupCreationLevel, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.miaixz.bus.gitlab.AbstractApi

gitLabApi

Fields inherited from interface org.miaixz.bus.gitlab.models.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor	Description
KeysApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Key	getKey(String keyId)	Get a single key by id.
Key	getUserBySSHKeyFingerprint(String fingerprint)

Methods inherited from class org.miaixz.bus.gitlab.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getNamespaceIdOrPath, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, putWithFormData, upload, upload, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeysApi

public KeysApi(GitLabApi gitLabApi)

Method Details

getUserBySSHKeyFingerprint

public Key getUserBySSHKeyFingerprint(String fingerprint)
                               throws GitLabApiException

Parameters:

fingerprint - The md5 hash of a ssh public key with : separating the bytes Or SHA256:$base64hash

Returns:

The Key which includes the user who owns the key

Throws:

GitLabApiException - If anything goes wrong

getKey

public Key getKey(String keyId)
           throws GitLabApiException

Get a single key by id.

 GitLab Endpoint: GET /keys/:id
 

Parameters:

keyId - the IID of the key to get

Returns:

a Key instance

Throws:

GitLabApiException - if any exception occurs