| Package | Description |
|---|---|
| org.gitlab4j.api | |
| org.gitlab4j.api.systemhooks | |
| org.gitlab4j.api.webhook |
| Modifier and Type | Method and Description |
|---|---|
static GitLabApiException |
GitLabApi.getOptionalException(Optional<?> optional)
Get the exception associated with the provided Optional instance, or null if no exception is
associated with the Optional instance.
|
protected GitLabApiException |
AbstractApi.handle(Exception thrown)
Wraps an exception in a GitLabApiException if needed.
|
| Modifier and Type | Method and Description |
|---|---|
protected static <T> Optional<T> |
GitLabApi.createOptionalFromException(GitLabApiException glae)
Create and return an Optional instance associated with a GitLabApiException.
|
| Modifier and Type | Method and Description |
|---|---|
MergeRequest |
MergeRequestApi.acceptMergeRequest(Integer projectId,
Integer mergeRequestIid)
Merge changes to the merge request.
|
MergeRequest |
MergeRequestApi.acceptMergeRequest(Integer projectId,
Integer mergeRequestIid,
String mergeCommitMessage,
Boolean shouldRemoveSourceBranch,
Boolean mergeWhenPipelineSucceeds)
Merge changes to the merge request.
|
MergeRequest |
MergeRequestApi.acceptMergeRequest(Integer projectId,
Integer mergeRequestIid,
String mergeCommitMessage,
Boolean shouldRemoveSourceBranch,
Boolean mergeWhenPipelineSucceeds,
String sha)
Merge changes to the merge request.
|
Milestone |
MilestonesApi.activateMilestone(Integer projectId,
Integer milestoneId)
Activate a milestone.
|
Comment |
CommitsApi.addComment(Object projectIdOrPath,
String sha,
String note)
Add a comment to a commit.
|
Comment |
CommitsApi.addComment(Object projectIdOrPath,
String sha,
String note,
String path,
Integer line,
Constants.LineType lineType)
Add a comment to a commit.
|
CommitStatus |
CommitsApi.addCommitStatus(Object projectIdOrPath,
String sha,
Constants.CommitBuildState state,
CommitStatus status)
Add or update the build status of a commit.
|
DeployKey |
DeployKeysApi.addDeployKey(Integer projectId,
String title,
String key,
Boolean canPush)
Creates a new deploy key for a project.
|
Group |
GroupApi.addGroup(Group group) |
Group |
GroupApi.addGroup(String name,
String path)
Creates a new project group.
|
Group |
GroupApi.addGroup(String name,
String path,
String description,
Boolean membershipLock,
Boolean shareWithGroupLock,
Visibility visibility,
Boolean lfsEnabled,
Boolean requestAccessEnabled,
Integer parentId,
Integer sharedRunnersMinutesLimit)
Deprecated.
Will be removed in version 5.0, replaced by
GroupApi.addGroup(String, String, String, Visibility,
Boolean, Boolean, Integer) |
Group |
GroupApi.addGroup(String name,
String path,
String description,
Visibility visibility,
Boolean lfsEnabled,
Boolean requestAccessEnabled,
Integer parentId)
Creates a new project group.
|
ProjectHook |
ProjectApi.addHook(Object projectIdOrPath,
String url,
boolean doPushEvents,
boolean doIssuesEvents,
boolean doMergeRequestsEvents)
Adds a hook to project.
|
ProjectHook |
ProjectApi.addHook(Object projectIdOrPath,
String url,
ProjectHook enabledHooks,
boolean enableSslVerification,
String secretToken)
Adds a hook to project.
|
ProjectHook |
ProjectApi.addHook(String projectName,
String url,
ProjectHook enabledHooks,
boolean enableSslVerification,
String secretToken)
Adds a hook to project.
|
AwardEmoji |
AwardEmojiApi.addIssueAwardEmoji(Object projectIdOrPath,
Integer issueIid,
String name)
Add an award emoji for the specified issue.
|
void |
GroupApi.addLdapGroupLink(Object groupIdOrPath,
String cn,
AccessLevel groupAccess,
String provider)
Adds an LDAP group link.
|
void |
GroupApi.addLdapGroupLink(Object groupIdOrPath,
String cn,
Integer groupAccess,
String provider)
Adds an LDAP group link.
|
Member |
GroupApi.addMember(Integer groupId,
Integer userId,
AccessLevel accessLevel)
Adds a user to the list of group members.
|
Member |
GroupApi.addMember(Integer groupId,
Integer userId,
AccessLevel accessLevel,
Date expiresAt)
Adds a user to the list of group members.
|
Member |
GroupApi.addMember(Integer groupId,
Integer userId,
Integer accessLevel)
Adds a user to the list of group members.
|
Member |
GroupApi.addMember(Integer groupId,
Integer userId,
Integer accessLevel,
Date expiresAt)
Adds a user to the list of group members.
|
Member |
ProjectApi.addMember(Object projectIdOrPath,
Integer userId,
AccessLevel accessLevel)
Adds a user to a project team.
|
Member |
ProjectApi.addMember(Object projectIdOrPath,
Integer userId,
AccessLevel accessLevel,
Date expiresAt)
Adds a user to a project team.
|
Member |
ProjectApi.addMember(Object projectIdOrPath,
Integer userId,
Integer accessLevel)
Adds a user to a project team.
|
Member |
ProjectApi.addMember(Object projectIdOrPath,
Integer userId,
Integer accessLevel,
Date expiresAt)
Adds a user to a project team.
|
AwardEmoji |
AwardEmojiApi.addMergeRequestAwardEmoji(Object projectIdOrPath,
Integer mergeRequestIid,
String name)
Add an award emoji to the specified merge request.
|
AwardEmoji |
AwardEmojiApi.addNoteAwardEmoji(Object projectIdOrPath,
Integer issueIid,
Integer noteId,
String name)
Add an award emoji for the specified note.
|
AwardEmoji |
AwardEmojiApi.addSnippetAwardEmoji(Object projectIdOrPath,
Integer snippetId,
String name)
Add an award emoji to the specified snippet.
|
TimeStats |
IssuesApi.addSpentTime(Integer projectId,
Integer issueIid,
Duration duration)
Adds spent time for this issue
POST /projects/:id/issues/:issue_iid/add_spent_time
|
TimeStats |
IssuesApi.addSpentTime(Integer projectId,
Integer issueIid,
int duration)
Adds spent time for this issue
POST /projects/:id/issues/:issue_iid/add_spent_time
|
TimeStats |
IssuesApi.addSpentTime(Integer projectId,
Integer issueIid,
String duration)
Adds spent time for this issue
POST /projects/:id/issues/:issue_iid/add_spent_time
|
SshKey |
UserApi.addSshKey(Integer userId,
String title,
String key)
Create new key owned by specified user.
|
SshKey |
UserApi.addSshKey(String title,
String key)
Creates a new key owned by the currently authenticated user.
|
SystemHook |
SystemHooksApi.addSystemHook(String url,
String token,
Boolean pushEvents,
Boolean tagPushEvents,
Boolean enablSsslVerification)
Add a new system hook.
|
List<T> |
Pager.all()
Gets all the items from each page as a single List instance.
|
MergeRequest |
MergeRequestApi.approveMergeRequest(Integer projectId,
Integer mergeRequestIid,
String sha)
Approve a merge request.
|
Project |
ProjectApi.archiveProject(Object projectIdOrPath)
Archive a project
POST /projects/:id/archive
|
EpicIssue |
EpicsApi.assignIssue(Object groupIdOrPath,
Integer epicIid,
Integer issueIid)
Creates an epic - issue association.
|
void |
UserApi.blockUser(Integer userId)
Blocks the specified user.
|
MergeRequest |
MergeRequestApi.cancelMergeRequest(Integer projectId,
Integer mergeRequestIid)
Cancel merge when pipeline succeeds.
|
Pipeline |
PipelineApi.cancelPipelineJobs(int projectId,
int pipelineId)
Cancel jobs of specified pipelines in a project.
|
Job |
JobApi.cancleJob(Object projectIdOrPath,
int jobId)
Cancel specified job in a project.
|
CustomAttribute |
UserApi.changeCustomAttribute(Integer userId,
CustomAttribute customAttribute)
Change custom attribute for the given user
|
CustomAttribute |
UserApi.changeCustomAttribute(Integer userId,
String key,
String value)
Changes custom attribute for the given user
|
Issue |
IssuesApi.closeIssue(Integer projectId,
Integer issueIid)
Closes an existing project issue.
|
Milestone |
MilestonesApi.closeMilestone(Integer projectId,
Integer milestoneId)
Close a milestone.
|
CompareResults |
RepositoryApi.compare(Object projectIdOrPath,
String from,
String to)
Compare branches, tags or commits.
|
static GitLabApi |
GitLabApi.create(String url,
String username,
String password)
Deprecated.
As of release 4.2.0, replaced by
GitLabApi.login(String, String, String), will be removed in 4.9.0 |
Branch |
RepositoryApi.createBranch(Object projectIdOrPath,
String branchName,
String ref)
Creates a branch for the project.
|
Commit |
CommitsApi.createCommit(Object projectIdOrPath,
String branch,
String commitMessage,
String startBranch,
String authorEmail,
String authorName,
List<CommitAction> actions)
Create a commit with multiple files and actions.
|
CustomAttribute |
UserApi.createCustomAttribute(Integer userId,
CustomAttribute customAttribute)
Creates custom attribute for the given user
|
CustomAttribute |
UserApi.createCustomAttribute(Integer userId,
String key,
String value)
Creates custom attribute for the given user
|
Project |
ProjectApi.createdForkedFromRelationship(Object projectIdOrPath,
Integer forkedFromId)
Create a forked from/to relation between existing projects.
|
Epic |
EpicsApi.createEpic(Object groupIdOrPath,
Epic epic)
Creates a new epic using the information contained in the provided Epic instance.
|
Epic |
EpicsApi.createEpic(Object groupIdOrPath,
String title,
String labels,
String description,
Date startDate,
Date endDate)
Creates a new epic.
|
RepositoryFile |
RepositoryFileApi.createFile(RepositoryFile file,
Integer projectId,
String branchName,
String commitMessage)
Create new file in repository
POST /projects/:id/repository/files
file_path (required) - Full path to new file.
|
ImpersonationToken |
UserApi.createImpersonationToken(Integer userId,
String name,
Date expiresAt,
ImpersonationToken.Scope[] scopes)
Create an impersonation token.
|
Issue |
IssuesApi.createIssue(Integer projectId,
String title,
String description)
Create an issue for the project.
|
Issue |
IssuesApi.createIssue(Integer projectId,
String title,
String description,
Boolean confidential,
List<Integer> assigneeIds,
Integer milestoneId,
String labels,
Date createdAt,
Date dueDate,
Integer mergeRequestToResolveId,
Integer discussionToResolveId)
Create an issue for the project.
|
Note |
NotesApi.createIssueNote(Integer projectId,
Integer issueIid,
String body)
Create a issues's note.
|
Note |
NotesApi.createIssueNote(Integer projectId,
Integer issueIid,
String body,
Date createdAt)
Create a issues's note.
|
Label |
LabelsApi.createLabel(Integer projectId,
String name,
String color)
Create a label
|
Label |
LabelsApi.createLabel(Integer projectId,
String name,
String color,
Integer priority)
Create a label
|
Label |
LabelsApi.createLabel(Integer projectId,
String name,
String color,
String description)
Create a label
|
Label |
LabelsApi.createLabel(Integer projectId,
String name,
String color,
String description,
Integer priority)
Create a label
|
MergeRequest |
MergeRequestApi.createMergeRequest(Integer projectId,
String sourceBranch,
String targetBranch,
String title,
String description,
Integer assigneeId)
Creates a merge request and optionally assigns a reviewer to it.
|
MergeRequest |
MergeRequestApi.createMergeRequest(Integer projectId,
String sourceBranch,
String targetBranch,
String title,
String description,
Integer assigneeId,
Integer targetProjectId,
String[] labels,
Integer milestoneId,
Boolean removeSourceBranch)
Creates a merge request and optionally assigns a reviewer to it.
|
MergeRequest |
MergeRequestApi.createMergeRequest(Integer projectId,
String sourceBranch,
String targetBranch,
String title,
String description,
Integer assigneeId,
Integer targetProjectId,
String[] labels,
Integer milestoneId,
Boolean removeSourceBranch,
Boolean squash)
Creates a merge request and optionally assigns a reviewer to it.
|
Note |
NotesApi.createMergeRequestNote(Integer projectId,
Integer mergeRequestIid,
String body)
Create a merge request's note.
|
Milestone |
MilestonesApi.createMilestone(Integer projectId,
String title,
String description,
Date dueDate,
Date startDate)
Create a milestone.
|
WikiPage |
WikisApi.createPage(Integer projectId,
String title,
String content)
Creates a new project wiki page.
|
Pipeline |
PipelineApi.createPipeline(int projectId,
String ref)
Create a pipelines in a project.
|
Project |
ProjectApi.createProject(Integer groupId,
String projectName)
Create a new project in the specified group.
|
Project |
ProjectApi.createProject(Project project)
Creates new project owned by the current user.
|
Project |
ProjectApi.createProject(Project project,
String importUrl)
Creates new project owned by the current user.
|
Project |
ProjectApi.createProject(String projectName)
Create a new project with the current user's namespace.
|
Project |
ProjectApi.createProject(String name,
Integer namespaceId,
String description,
Boolean issuesEnabled,
Boolean mergeRequestsEnabled,
Boolean wikiEnabled,
Boolean snippetsEnabled,
Boolean isPublic,
Integer visibilityLevel,
String importUrl)
Deprecated.
As of release 4.2.0, replaced by
ProjectApi.createProject(String, Integer, String, Boolean, Boolean,
Boolean, Boolean, Visibility, Integer, String) |
Project |
ProjectApi.createProject(String name,
Integer namespaceId,
String description,
Boolean issuesEnabled,
Boolean mergeRequestsEnabled,
Boolean wikiEnabled,
Boolean snippetsEnabled,
Visibility visibility,
Integer visibilityLevel,
Boolean printingMergeRequestLinkEnabled,
String importUrl)
Creates a Project
|
Project |
ProjectApi.createProject(String name,
Integer namespaceId,
String description,
Boolean issuesEnabled,
Boolean mergeRequestsEnabled,
Boolean wikiEnabled,
Boolean snippetsEnabled,
Visibility visibility,
Integer visibilityLevel,
String importUrl)
Creates a Project
|
PushRules |
ProjectApi.createPushRules(Object projectIdOrPath,
PushRules pushRule)
Adds a push rule to a specified project.
|
Release |
TagsApi.createRelease(Object projectIdOrPath,
String tagName,
String releaseNotes)
Add release notes to the existing git tag.
|
Snippet |
ProjectApi.createSnippet(Object projectIdOrPath,
String title,
String filename,
String description,
String code,
Visibility visibility)
Creates a new project snippet.
|
Snippet |
SnippetsApi.createSnippet(String title,
String fileName,
String content)
Create a new Snippet.
|
Snippet |
SnippetsApi.createSnippet(String title,
String fileName,
String content,
Visibility visibility,
String description)
Create a new Snippet.
|
Tag |
TagsApi.createTag(Object projectIdOrPath,
String tagName,
String ref,
String message,
File releaseNotesFile)
Creates a tag on a particular ref of a given project.
|
Tag |
RepositoryApi.createTag(Object projectIdOrPath,
String tagName,
String ref,
String message,
File releaseNotesFile)
Deprecated.
Replaced by TagsApi.CreateTag(Object, String, String, String, File)
|
Tag |
TagsApi.createTag(Object projectIdOrPath,
String tagName,
String ref,
String message,
String releaseNotes)
Creates a tag on a particular ref of the given project.
|
Tag |
RepositoryApi.createTag(Object projectIdOrPath,
String tagName,
String ref,
String message,
String releaseNotes)
Deprecated.
Replaced by TagsApi.createTag(Object, String, String, String, String)
|
User |
UserApi.createUser(User user,
CharSequence password,
boolean resetPassword)
Creates a new user.
|
User |
UserApi.createUser(User user,
CharSequence password,
Integer projectsLimit)
Deprecated.
Will be removed in version 5.0, replaced by
UserApi.createUser(User, CharSequence, boolean) |
List<T> |
Pager.current()
Returns the current page of List.
|
protected javax.ws.rs.core.Response |
AbstractApi.delete(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
Object... pathArgs)
Perform an HTTP DELETE call with the specified form data and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.delete(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
URL url)
Perform an HTTP DELETE call with the specified form data and URL, returning
a ClientResponse instance with the data returned from the endpoint.
|
void |
RepositoryApi.deleteBranch(Object projectIdOrPath,
String branchName)
Delete a single project repository branch.
|
void |
UserApi.deleteCustomAttribute(Integer userId,
CustomAttribute customAttribute)
Delete a custom attribute for the given user
|
void |
UserApi.deleteCustomAttribute(Integer userId,
String key)
Delete a custom attribute for the given user
|
void |
DeployKeysApi.deleteDeployKey(Integer projectId,
Integer keyId)
Removes a deploy key from the project.
|
void |
EpicsApi.deleteEpic(Object groupIdOrPath,
Integer epicIid)
Deletes an epic.
|
void |
ServicesApi.deleteExternalWikiService(Object projectIdOrPath)
Deletes the ExternalWiki service for a project.
|
void |
RepositoryFileApi.deleteFile(String filePath,
Integer projectId,
String branchName,
String commitMessage)
Delete existing file in repository
DELETE /projects/:id/repository/files
file_path (required) - Full path to file.
|
void |
ProjectApi.deleteForkedFromRelationship(Object projectIdOrPath)
Delete an existing forked from relationship.
|
void |
ServicesApi.deleteGitLabCI(Object projectIdOrPath)
Deprecated.
No longer supported
|
void |
GroupApi.deleteGroup(Group group)
Removes group with all projects inside.
|
void |
GroupApi.deleteGroup(Integer groupId)
Removes group with all projects inside.
|
void |
ServicesApi.deleteHipChat(Object projectIdOrPath)
Deprecated.
replaced with
updateHipChat method |
void |
ServicesApi.deleteHipChatService(Object projectIdOrPath)
Deletes the HipChatService service for a project.
|
void |
ProjectApi.deleteHook(Object projectIdOrPath,
Integer hookId)
Deletes a hook from the project.
|
void |
ProjectApi.deleteHook(ProjectHook hook)
Deletes a hook from the project.
|
void |
IssuesApi.deleteIssue(Integer projectId,
Integer issueIid)
Delete an issue.
|
void |
ProjectApi.deleteIssue(Object projectIdOrPath,
Integer issueId)
Deprecated.
Will be removed in version 5.0, replaced by
IssuesApi.deleteIssue(Integer, Integer) |
void |
AwardEmojiApi.deleteIssueAwardEmoji(Object projectIdOrPath,
Integer issueIid,
Integer awardId)
Delete an award emoji from the specified issue.
|
void |
NotesApi.deleteIssueNote(Integer projectId,
Integer issueIid,
Integer noteId)
Delete the specified issues's note.
|
void |
ServicesApi.deleteJiraService(Object projectIdOrPath)
Deletes the JIRA service for a project.
|
void |
LabelsApi.deleteLabel(Integer projectId,
String name)
Delete the specified label
|
void |
GroupApi.deleteLdapGroupLink(Object groupIdOrPath,
String cn)
Deletes an LDAP group link.
|
void |
GroupApi.deleteLdapGroupLink(Object groupIdOrPath,
String cn,
String provider)
Deletes an LDAP group link for a specific LDAP provider.
|
void |
MergeRequestApi.deleteMergeRequest(Integer projectId,
Integer mergeRequestIid)
Only for admins and project owners.
|
void |
AwardEmojiApi.deleteMergeRequestAwardEmoji(Object projectIdOrPath,
Integer mergeRequestIid,
Integer awardId)
Delete an award emoji from the specified merge request.
|
void |
NotesApi.deleteMergeRequestNote(Integer projectId,
Integer mergeRequestIid,
Integer noteId)
Delete the specified merge request's note.
|
void |
AwardEmojiApi.deleteNoteAwardEmoji(Object projectIdOrPath,
Integer issueIid,
Integer noteId,
Integer awardId)
Delete an award emoji from the specified note.
|
void |
WikisApi.deletePage(Integer projectId,
String slug)
Deletes an existing project wiki page.
|
void |
ProjectApi.deleteProject(Object projectIdOrPath)
Removes project with all resources(issues, merge requests etc).
|
void |
ProjectApi.deletePushRules(Object projectIdOrPath)
Removes a push rule from a project.
|
void |
RunnersApi.deleteRunner(String token)
Deletes a registered Runner.
|
void |
ServicesApi.deleteSlackService(Object projectIdOrPath)
Deletes the Slack notifications service for a project.
|
void |
SnippetsApi.deleteSnippet(Integer snippetId)
Removes Snippet.
|
void |
ProjectApi.deleteSnippet(Object projectIdOrPath,
Integer snippetId) |
void |
AwardEmojiApi.deleteSnippetAwardEmoji(Object projectIdOrPath,
Integer snippetId,
Integer awardId)
Delete an award emoji from the specified snippet.
|
void |
UserApi.deleteSshKey(Integer keyId)
Deletes key owned by currently authenticated user.
|
void |
UserApi.deleteSshKey(Integer userId,
Integer keyId)
Deletes key owned by a specified user.
|
void |
SystemHooksApi.deleteSystemHook(Integer hookId)
Deletes a system hook.
|
void |
SystemHooksApi.deleteSystemHook(SystemHook hook)
Deletes a system hook.
|
void |
TagsApi.deleteTag(Object projectIdOrPath,
String tagName)
Deletes the tag from a project with the specified tag name.
|
void |
RepositoryApi.deleteTag(Object projectIdOrPath,
String tagName)
Deprecated.
Replaced by TagsApi.deleteTag(Object, String)
|
void |
UserApi.deleteUser(Integer userId)
Deletes a user.
|
void |
UserApi.deleteUser(Integer userId,
Boolean hardDelete)
Deletes a user.
|
void |
UserApi.deleteUser(User user)
Deletes a user.
|
void |
UserApi.deleteUser(User user,
Boolean hardDelete)
Deletes a user.
|
Runner |
RunnersApi.disableRunner(Integer projectId,
Integer runnerId)
Disable a specific runner from the project.
|
InputStream |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
Integer jobId)
Get an InputStream pointing to the job artifacts file for the specified job ID.
|
InputStream |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
Integer jobId,
ArtifactsFile artifactsFile)
Download a single artifact file from within the job's artifacts archive.
|
File |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
Integer jobId,
ArtifactsFile artifactsFile,
File directory)
Download a single artifact file from within the job's artifacts archive.
|
File |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
Integer jobId,
File directory)
Download the job artifacts file for the specified job ID.
|
InputStream |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
String ref,
String jobName)
Get an InputStream pointing to the artifacts file from the given reference name and job
provided the job finished successfully.
|
File |
JobApi.downloadArtifactsFile(Object projectIdOrPath,
String ref,
String jobName,
File directory)
Download the artifacts file from the given reference name and job provided the job finished successfully.
|
InputStream |
JobApi.downloadSingleArtifactsFile(Object projectIdOrPath,
Integer jobId,
Path artifactPath)
Download a single artifact file from within the job's artifacts archive.
|
File |
JobApi.downloadSingleArtifactsFile(Object projectIdOrPath,
Integer jobId,
Path artifactPath,
File directory)
Download a single artifact file from within the job's artifacts archive.
|
DeployKey |
DeployKeysApi.enableDeployKey(Integer projectId,
Integer keyId)
Enables a deploy key for a project so this can be used.
|
Runner |
RunnersApi.enableRunner(Integer projectId,
Integer runnerId)
Enable an available specific runner in the project.
|
Job |
JobApi.eraseJob(Object projectIdOrPath,
int jobId)
Erase specified job in a project.
|
TimeStats |
IssuesApi.estimateTime(Integer projectId,
Integer issueIid,
Duration duration)
Sets an estimated time of work in this issue
POST /projects/:id/issues/:issue_iid/time_estimate
|
TimeStats |
IssuesApi.estimateTime(Integer projectId,
Integer issueIid,
int duration)
Sets an estimated time of work in this issue
POST /projects/:id/issues/:issue_iid/time_estimate
|
TimeStats |
IssuesApi.estimateTime(Integer projectId,
Integer issueIid,
String duration)
Sets an estimated time of work in this issue
POST /projects/:id/issues/:issue_iid/time_estimate
|
List<Namespace> |
NamespaceApi.findNamespaces(String query)
Get all namespaces that match a string in their name or path.
|
Pager<Namespace> |
NamespaceApi.findNamespaces(String query,
int itemsPerPage)
Get a Pager of all namespaces that match a string in their name or path.
|
List<Namespace> |
NamespaceApi.findNamespaces(String query,
int page,
int perPage)
Get all namespaces that match a string in their name or path in the specified page range.
|
List<User> |
UserApi.findUsers(String emailOrUsername)
Search users by Email or username
|
Pager<User> |
UserApi.findUsers(String emailOrUsername,
int itemsPerPage)
Search users by Email or username and return a Pager
|
List<User> |
UserApi.findUsers(String emailOrUsername,
int page,
int perPage)
Search users by Email or username in the specified page range.
|
List<T> |
Pager.first()
Returns the first page of List.
|
Project |
ProjectApi.forkProject(Object projectIdOrPath,
Integer namespaceId)
Forks a project into the user namespace of the authenticated user or the one provided.
|
Project |
ProjectApi.forkProject(Object projectIdOrPath,
String namespace)
Forks a project into the user namespace of the authenticated user or the one provided.
|
static Constants.ArchiveFormat |
Constants.ArchiveFormat.forValue(String value) |
protected javax.ws.rs.core.Response |
AbstractApi.get(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
Object... pathArgs)
Perform an HTTP GET call with the specified query parameters and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.get(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
URL url)
Perform an HTTP GET call with the specified query parameters and URL, returning
a ClientResponse instance with the data returned from the endpoint.
|
List<User> |
UserApi.getActiveUsers()
Get a list of active users.
|
Pager<User> |
UserApi.getActiveUsers(int itemsPerPage)
Get a Pager of active users.
|
List<User> |
UserApi.getActiveUsers(int page,
int perPage)
Get a list of active users using the specified page and per page settings.
|
List<LicenseTemplate> |
LicensesApi.getAllLicenseTemplates()
Get all license templates.
|
List<Project> |
ProjectApi.getAllProjects()
Deprecated.
Will be removed, no longer supported by the GitLab API
|
List<Runner> |
RunnersApi.getAllRunners()
Get a list of all runners in the GitLab instance (specific and shared).
|
Pager<Runner> |
RunnersApi.getAllRunners(int itemsPerPage)
Get a list of all runners in the GitLab instance (specific and shared).
|
List<Runner> |
RunnersApi.getAllRunners(int page,
int perPage)
Get a list of all runners in the GitLab instance (specific and shared).
|
List<Runner> |
RunnersApi.getAllRunners(Runner.RunnerStatus scope)
Get a list of all runners in the GitLab instance (specific and shared).
|
Pager<Runner> |
RunnersApi.getAllRunners(Runner.RunnerStatus scope,
int itemsPerPage)
Get a list of all runners in the GitLab instance (specific and shared).
|
List<Runner> |
RunnersApi.getAllRunners(Runner.RunnerStatus scope,
Integer page,
Integer perPage)
Get a list of all runners in the GitLab instance (specific and shared).
|
List<Event> |
EventsApi.getAuthenticatedUserEvents(Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder)
Get a list of events for the authenticated user.
|
Pager<Event> |
EventsApi.getAuthenticatedUserEvents(Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int itemsPerPage)
Get a list of events for the authenticated user and in the specified page range.
|
List<Event> |
EventsApi.getAuthenticatedUserEvents(Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int page,
int perPage)
Get a list of events for the authenticated user and in the specified page range.
|
List<User> |
UserApi.getBlockedUsers()
Get a list of blocked users.
|
Pager<User> |
UserApi.getBlockedUsers(int itemsPerPage)
Get a Pager of blocked users.
|
List<User> |
UserApi.getblockedUsers(int page,
int perPage)
Get a list of blocked users using the specified page and per page settings.
|
Branch |
RepositoryApi.getBranch(Object projectIdOrPath,
String branchName)
Get a single project repository branch.
|
List<Branch> |
RepositoryApi.getBranches(Object projectIdOrPath)
Get a list of repository branches from a project, sorted by name alphabetically.
|
Pager<Branch> |
RepositoryApi.getBranches(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of repository branches from a project, sorted by name alphabetically.
|
List<Branch> |
RepositoryApi.getBranches(Object projectIdOrPath,
int page,
int perPage)
Get a list of repository branches from a project, sorted by name alphabetically.
|
List<MergeRequest> |
IssuesApi.getClosedByMergeRequests(Object projectIdOrPath,
Integer issueIid)
Get list containing all the merge requests that will close issue when merged.
|
Pager<MergeRequest> |
IssuesApi.getClosedByMergeRequests(Object projectIdOrPath,
Integer issueIid,
int itemsPerPage)
Get a Pager containing all the merge requests that will close issue when merged.
|
List<MergeRequest> |
IssuesApi.getClosedByMergeRequests(Object projectIdOrPath,
Integer issueIid,
int page,
int perPage)
Get list containing all the merge requests that will close issue when merged.
|
List<Issue> |
MergeRequestApi.getClosesIssues(Object projectIdOrPath,
Integer mergeRequestIid)
Get list containing all the issues that would be closed by merging the provided merge requestt.
|
Pager<Issue> |
MergeRequestApi.getClosesIssues(Object projectIdOrPath,
Integer mergeRequestIid,
int itemsPerPage)
Get a Pager containing all the issues that would be closed by merging the provided merge request.
|
List<Issue> |
MergeRequestApi.getClosesIssues(Object projectIdOrPath,
Integer mergeRequestIid,
int page,
int perPage)
Get list containing all the issues that would be closed by merging the provided merge request.
|
List<Comment> |
CommitsApi.getComments(Object projectIdOrPath,
String sha)
Get the comments of a commit in a project.
|
Pager<Comment> |
CommitsApi.getComments(Object projectIdOrPath,
String sha,
int itemsPerPage)
Get a Pager of the comments of a commit in a project.
|
Commit |
CommitsApi.getCommit(Object projectIdOrPath,
String sha)
Get a specific commit identified by the commit hash or name of a branch or tag.
|
List<CommitRef> |
CommitsApi.getCommitRefs(Object projectIdOrPath,
String sha)
Get a specific commit identified by the commit hash or name of a branch or tag as an Optional instance
GET /projects/:id/repository/commits/:sha/refs
|
List<CommitRef> |
CommitsApi.getCommitRefs(Object projectIdOrPath,
String sha,
CommitRef.RefType refType)
Get a specific commit identified by the commit hash or name of a branch or tag as an Optional instance
GET /projects/:id/repository/commits/:sha/refs?type=:refType
|
List<Commit> |
MergeRequestApi.getCommits(int projectId,
int mergeRequestIid)
Get a list of merge request commits.
|
Pager<Commit> |
MergeRequestApi.getCommits(int projectId,
int mergeRequestIid,
int itemsPerPage)
Get a Pager of merge request commits.
|
List<Commit> |
MergeRequestApi.getCommits(int projectId,
int mergeRequestIid,
int page,
int perPage)
Get a list of merge request commits.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath)
Get a list of repository commits in a project.
|
Pager<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of repository commits in a project.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
int page,
int perPage)
Get a list of repository commits in a project.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until)
Get a list of repository commits in a project.
|
Pager<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until,
int itemsPerPage)
Get a Pager of repository commits in a project.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until,
int page,
int perPage)
Get a list of repository commits in a project.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until,
String path)
Get a list of repository commits in a project.
|
Pager<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until,
String path,
int itemsPerPage)
Get a Pager of repository commits in a project
GET /projects/:id/repository/commits
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
Date since,
Date until,
String path,
int page,
int perPage)
Get a list of repository commits in a project.
|
List<Commit> |
CommitsApi.getCommits(Object projectIdOrPath,
String ref,
String path)
Get a list of file commits in a project
GET /projects/:id/repository/commits?path=:file_path
|
List<CommitStatus> |
CommitsApi.getCommitStatuses(Object projectIdOrPath,
String sha,
CommitStatusFilter filter)
Get a list of repository commit statuses that meet the provided filter.
|
Pager<CommitStatus> |
CommitsApi.getCommitStatuses(Object projectIdOrPath,
String sha,
CommitStatusFilter filter,
int itemsPerPage)
Get a Pager of repository commit statuses that meet the provided filter.
|
List<CommitStatus> |
CommitsApi.getCommitStatuses(Object projectIdOrPath,
String sha,
CommitStatusFilter filter,
int page,
int perPage)
Get a list of repository commit statuses that meet the provided filter.
|
List<Contributor> |
RepositoryApi.getContributors(Object projectIdOrPath)
Get a list of contributors from a project.
|
Pager<Contributor> |
RepositoryApi.getContributors(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of contributors from a project.
|
List<Contributor> |
RepositoryApi.getContributors(Object projectIdOrPath,
int page,
int perPage)
Get a list of contributors from a project and in the specified page range.
|
User |
UserApi.getCurrentUser()
Get currently authenticated user.
|
DeployKey |
DeployKeysApi.getDeployKey(Integer projectId,
Integer keyId)
Get a single deploy key for the specified project.
|
List<DeployKey> |
DeployKeysApi.getDeployKeys()
Get a list of all deploy keys across all projects of the GitLab instance.
|
Pager<DeployKey> |
DeployKeysApi.getDeployKeys(int itemsPerPage)
Get a Pager of all deploy keys across all projects of the GitLab instance.
|
List<DeployKey> |
DeployKeysApi.getDeployKeys(int page,
int perPage)
Get a list of all deploy keys across all projects of the GitLab instance using the specified page and per page settings.
|
List<Diff> |
CommitsApi.getDiff(Object projectIdOrPath,
String sha)
Get the list of diffs of a commit in a project.
|
Epic |
EpicsApi.getEpic(Object groupIdOrPath,
Integer epicIid)
Get a single epic for the specified group.
|
List<Epic> |
EpicsApi.getEpicIssues(Object groupIdOrPath,
Integer epicIid)
Gets all issues that are assigned to an epic and the authenticated user has access to.
|
Pager<Epic> |
EpicsApi.getEpicIssues(Object groupIdOrPath,
Integer epicIid,
int itemsPerPage)
Get a Pager of all issues that are assigned to an epic and the authenticated user has access to.
|
List<Epic> |
EpicsApi.getEpicIssues(Object groupIdOrPath,
Integer epicIid,
int page,
int perPage)
Gets all issues that are assigned to an epic and the authenticated user has access to
using the specified page and per page setting.
|
List<Epic> |
EpicsApi.getEpics(Object groupIdOrPath)
Gets all epics of the requested group and its subgroups.
|
Pager<Epic> |
EpicsApi.getEpics(Object groupIdOrPath,
int itemsPerPage)
Get a Pager of all epics of the requested group and its subgroups.
|
List<Epic> |
EpicsApi.getEpics(Object groupIdOrPath,
Integer authorId,
String labels,
Constants.EpicOrderBy orderBy,
Constants.SortOrder sortOrder,
String search)
Gets all epics of the requested group and its subgroups.
|
Pager<Epic> |
EpicsApi.getEpics(Object groupIdOrPath,
Integer authorId,
String labels,
Constants.EpicOrderBy orderBy,
Constants.SortOrder sortOrder,
String search,
int itemsPerPage)
Get a Pager of all epics of the requested group and its subgroups.
|
List<Epic> |
EpicsApi.getEpics(Object groupIdOrPath,
Integer authorId,
String labels,
Constants.EpicOrderBy orderBy,
Constants.SortOrder sortOrder,
String search,
int page,
int perPage)
Gets all epics of the requested group and its subgroups using the specified page and per page setting.
|
List<Epic> |
EpicsApi.getEpics(Object groupIdOrPath,
int page,
int perPage)
Gets all epics of the requested group and its subgroups using the specified page and per page setting.
|
ExternalWikiService |
ServicesApi.getExternalWikiService(Object projectIdOrPath)
Get the JIRA service settings for a project.
|
RepositoryFile |
RepositoryFileApi.getFile(Object projectIdOrPath,
String filePath,
String ref)
Get file from repository.
|
RepositoryFile |
RepositoryFileApi.getFile(Object projectIdOrPath,
String filePath,
String ref,
boolean includeContent)
Get file from repository.
|
RepositoryFile |
RepositoryFileApi.getFile(String filePath,
Integer projectId,
String ref)
Deprecated.
Will be removed in version 5.0, replaced by
RepositoryFileApi.getFile(Object, String, String) |
RepositoryFile |
RepositoryFileApi.getFileInfo(Object projectIdOrPath,
String filePath,
String ref)
Get information on a file in the repository.
|
protected RepositoryFile |
RepositoryFileApi.getFileV3(String filePath,
Integer projectId,
String ref)
Deprecated.
Will be removed in version 5.0
|
List<Project> |
ProjectApi.getForks(Object projectIdOrPath)
Get a list of projects that were forked from the specified project.
|
Pager<Project> |
ProjectApi.getForks(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of projects that were forked from the specified project.
|
List<Project> |
ProjectApi.getForks(Object projectIdOrPath,
int page,
int perPage)
Get a list of projects that were forked from the specified project and in the specified page range.
|
NotificationSettings |
NotificationSettingsApi.getGlobalNotificationSettings()
Get the global notification settings.
|
Group |
GroupApi.getGroup(Integer groupId)
Get all details of a group.
|
Group |
GroupApi.getGroup(String groupPath)
Get all details of a group.
|
Object |
AbstractApi.getGroupIdOrPath(Object obj)
Returns the group ID or path from the provided Integer, String, or Group instance.
|
NotificationSettings |
NotificationSettingsApi.getGroupNotificationSettings(int groupId)
Get the notification settings for a group.
|
List<Group> |
GroupApi.getGroups()
Get a list of groups.
|
Pager<Group> |
GroupApi.getGroups(int itemsPerPage)
Get a Pager of groups.
|
List<Group> |
GroupApi.getGroups(int page,
int perPage)
Get a list of groups (As user: my groups, as admin: all groups) and in the specified page range.
|
List<Group> |
GroupApi.getGroups(String search)
Get all groups that match your string in their name or path.
|
Pager<Group> |
GroupApi.getGroups(String search,
int itemsPerPage)
Get all groups that match your string in their name or path.
|
List<Group> |
GroupApi.getGroups(String search,
int page,
int perPage)
Get all groups that match your string in their name or path.
|
HipChatService |
ServicesApi.getHipChatService(Object projectIdOrPath)
Get the HipChatService notification configuration for a project.
|
ProjectHook |
ProjectApi.getHook(Object projectIdOrPath,
Integer hookId)
Get a specific hook for project.
|
List<ProjectHook> |
ProjectApi.getHooks(Object projectIdOrPath)
Get list of project hooks.
|
Pager<ProjectHook> |
ProjectApi.getHooks(Object projectIdOrPath,
int itemsPerPage)
Get Pager of project hooks.
|
List<ProjectHook> |
ProjectApi.getHooks(Object projectIdOrPath,
int page,
int perPage)
Get list of project hooks in the specified page range.
|
ImpersonationToken |
UserApi.getImpersonationToken(Integer userId,
Integer tokenId)
Get an impersonation token of a user.
|
List<ImpersonationToken> |
UserApi.getImpersonationTokens(Integer userId)
Get a list of a specified user's impersonation tokens.
|
List<ImpersonationToken> |
UserApi.getImpersonationTokens(Integer userId,
Constants.ImpersonationState state)
Get a list of a specified user's impersonation tokens.
|
Issue |
IssuesApi.getIssue(Integer projectId,
Integer issueId)
Get a single project issue.
|
Issue |
ProjectApi.getIssue(Object projectIdOrPath,
Integer issueId)
Deprecated.
Will be removed in version 5.0, replaced by
IssuesApi.getIssue(Integer, Integer) |
AwardEmoji |
AwardEmojiApi.getIssueAwardEmoji(Object projectIdOrPath,
Integer issueIid,
Integer awardId)
Get the specified award emoji for the specified issue.
|
List<AwardEmoji> |
AwardEmojiApi.getIssueAwardEmojis(Object projectIdOrPath,
Integer issueIid)
Get a list of award emoji for the specified issue.
|
Note |
NotesApi.getIssueNote(Integer projectId,
Integer issueIid,
Integer noteId)
Get the specified issues's note.
|
List<Note> |
NotesApi.getIssueNotes(Integer projectId,
Integer issueIid)
Get a list of the issues's notes.
|
Pager<Note> |
NotesApi.getIssueNotes(Integer projectId,
Integer issueIid,
int itemsPerPage)
Get a Pager of issues's notes.
|
List<Note> |
NotesApi.getIssueNotes(Integer projectId,
Integer issueIid,
int page,
int perPage)
Get a list of the issue's notes using the specified page and per page settings.
|
List<Issue> |
IssuesApi.getIssues()
Get all issues the authenticated user has access to.
|
Pager<Issue> |
IssuesApi.getIssues(int itemsPerPage)
Get a Pager of all issues the authenticated user has access to.
|
List<Issue> |
IssuesApi.getIssues(Integer projectId)
Get a list of project's issues.
|
Pager<Issue> |
IssuesApi.getIssues(Integer projectId,
int itemsPerPage)
Get a Pager of project's issues.
|
List<Issue> |
MilestonesApi.getIssues(Integer projectId,
Integer milestoneId)
Get the list of issues associated with the specified milestone.
|
List<Issue> |
IssuesApi.getIssues(Integer projectId,
int page,
int perPage)
Get a list of project's issues using the specified page and per page settings.
|
List<Issue> |
IssuesApi.getIssues(int page,
int perPage)
Get all issues the authenticated user has access to using the specified page and per page setting.
|
List<Issue> |
IssuesApi.getIssues(IssueFilter filter)
Get all issues the authenticated user has access to.
|
Pager<Issue> |
IssuesApi.getIssues(IssueFilter filter,
int itemsPerPage)
Get all issues the authenticated user has access to.
|
List<Issue> |
IssuesApi.getIssues(IssueFilter filter,
int page,
int perPage)
Get all issues the authenticated user has access to.
|
List<Issue> |
ProjectApi.getIssues(Object projectIdOrPath)
Deprecated.
Will be removed in version 5.0, replaced by
IssuesApi.getIssues(Integer) |
Pager<Issue> |
ProjectApi.getIssues(Object projectIdOrPath,
int itemsPerPage)
Deprecated.
Will be removed in version 5.0, replaced by
IssuesApi.getIssues(Integer, int) |
List<Issue> |
ProjectApi.getIssues(Object projectIdOrPath,
int page,
int perPage)
Deprecated.
Will be removed in version 5.0, replaced by
IssuesApi.getIssues(Integer, int, int) |
List<Issue> |
IssuesApi.getIssues(Object projectIdOrPath,
IssueFilter filter)
Get a list of project's issues.
|
Pager<Issue> |
IssuesApi.getIssues(Object projectIdOrPath,
IssueFilter filter,
int itemsPerPage)
Get a list of project's issues.
|
List<Issue> |
IssuesApi.getIssues(Object projectIdOrPath,
IssueFilter filter,
int page,
int perPage)
Get a list of project's issues.
|
JiraService |
ServicesApi.getJiraService(Object projectIdOrPath)
Get the JIRA service settings for a project.
|
Job |
JobApi.getJob(Object projectIdOrPath,
int jobId)
Get single job in a project.
|
List<Job> |
RunnersApi.getJobs(Integer runnerId)
List jobs that are being processed or were processed by specified Runner.
|
Pager<Job> |
RunnersApi.getJobs(Integer runnerId,
int itemsPerPage)
List jobs that are being processed or were processed by specified Runner.
|
List<Job> |
RunnersApi.getJobs(Integer runnerId,
JobStatus status)
List jobs that are being processed or were processed by specified Runner.
|
Pager<Job> |
RunnersApi.getJobs(Integer runnerId,
JobStatus status,
int itemsPerPage)
List jobs that are being processed or were processed by specified Runner.
|
List<Job> |
JobApi.getJobs(Object projectIdOrPath)
Get a list of jobs in a project.
|
List<Job> |
JobApi.getJobs(Object projectIdOrPath,
Constants.JobScope scope)
Get a list of jobs in a project.
|
Pager<Job> |
JobApi.getJobs(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of jobs in a project.
|
List<Job> |
JobApi.getJobs(Object projectIdOrPath,
int page,
int perPage)
Get a list of jobs in a project in the specified page range.
|
List<Job> |
JobApi.getJobsForPipeline(Object projectIdOrPath,
int pipelineId)
Get a list of jobs in a pipeline.
|
List<Job> |
JobApi.getJobsForPipeline(Object projectIdOrPath,
int pipelineId,
Constants.JobScope scope)
Get a list of jobs in a pipeline.
|
List<Label> |
LabelsApi.getLabels(Integer projectId)
Get all labels of the specified project.
|
List<Label> |
LabelsApi.getLabels(Integer projectId,
int page,
int perPage)
Get all labels of the specified project to using the specified page and per page setting
|
HealthCheckInfo |
HealthCheckApi.getLiveness()
Get Health Checks from the liveness endpoint.
|
HealthCheckInfo |
HealthCheckApi.getLiveness(String token)
Deprecated.
|
Markdown |
MarkdownApi.getMarkdown(String text)
Render an arbitrary Markdown document.
|
Member |
GroupApi.getMember(int groupId,
int userId)
Get a group member viewable by the authenticated user.
|
Member |
ProjectApi.getMember(Object projectIdOrPath,
Integer userId)
Gets a project team member.
|
List<Project> |
ProjectApi.getMemberProjects()
Get a list of projects that the authenticated user is a member of.
|
Pager<Project> |
ProjectApi.getMemberProjects(int itemsPerPage)
Get a Pager of projects that the authenticated user is a member of.
|
List<Project> |
ProjectApi.getMemberProjects(int page,
int perPage)
Get a list of projects that the authenticated user is a member of in the specified page range.
|
List<Member> |
GroupApi.getMembers(int groupId)
Get a list of group members viewable by the authenticated user.
|
Pager<Member> |
GroupApi.getMembers(int groupId,
int itemsPerPage)
Get a Pager of group members viewable by the authenticated user.
|
List<Member> |
GroupApi.getMembers(int groupId,
int page,
int perPage)
Get a list of group members viewable by the authenticated user in the specified page range.
|
List<Member> |
ProjectApi.getMembers(Object projectIdOrPath)
Get a list of project team members.
|
Pager<Member> |
ProjectApi.getMembers(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of project team members.
|
List<Member> |
ProjectApi.getMembers(Object projectIdOrPath,
int page,
int perPage)
Get a list of project team members in the specified page range.
|
List<MergeRequest> |
MilestonesApi.getMergeRequest(Integer projectId,
Integer milestoneId)
Get the list of merge requests associated with the specified milestone.
|
MergeRequest |
MergeRequestApi.getMergeRequest(Integer projectId,
Integer mergeRequestIid)
Get information about a single merge request.
|
MergeRequest |
MergeRequestApi.getMergeRequestApprovals(Integer projectId,
Integer mergeRequestIid)
Get the merge request with approval information.
|
AwardEmoji |
AwardEmojiApi.getMergeRequestAwardEmoji(Object projectIdOrPath,
Integer mergeRequestIid,
Integer awardId)
Get the specified award emoji for the specified merge request.
|
List<AwardEmoji> |
AwardEmojiApi.getMergeRequestAwardEmojis(Object projectIdOrPath,
Integer mergeRequestIid)
Get a list of award emoji for the specified merge request.
|
MergeRequest |
MergeRequestApi.getMergeRequestChanges(Integer projectId,
Integer mergeRequestIid)
Get merge request with changes information.
|
Note |
NotesApi.getMergeRequestNote(Integer projectId,
Integer mergeRequestIid,
Integer noteId)
Get the specified merge request's note.
|
List<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid)
Gets a list of all notes for a single merge request.
|
List<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid,
Constants.SortOrder sortOrder,
Note.OrderBy orderBy)
Gets a list of all notes for a single merge request.
|
Pager<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid,
Constants.SortOrder sortOrder,
Note.OrderBy orderBy,
int itemsPerPage)
Get a Pager of all notes for a single merge request
GET /projects/:id/merge_requests/:merge_request_iid/notes
|
List<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid,
Constants.SortOrder sortOrder,
Note.OrderBy orderBy,
int page,
int perPage)
Gets a list of all notes for a single merge request using the specified page and per page settings.
|
Pager<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid,
int itemsPerPage)
Get a Pager of all notes for a single merge request
GET /projects/:id/merge_requests/:merge_request_iid/notes
|
List<Note> |
NotesApi.getMergeRequestNotes(Integer projectId,
Integer mergeRequestIid,
int page,
int perPage)
Gets a list of all notes for a single merge request using the specified page and per page settings.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId)
Get all merge requests for the specified project.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId,
Constants.MergeRequestState state)
Get all merge requests with a specific state for the specified project.
|
Pager<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId,
Constants.MergeRequestState state,
int itemsPerPage)
Get all merge requests for the specified project.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId,
Constants.MergeRequestState state,
int page,
int perPage)
Get all merge requests for the specified project.
|
Pager<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId,
int itemsPerPage)
Get all merge requests for the specified project.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(Integer projectId,
int page,
int perPage)
Get all merge requests for the specified project.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(MergeRequestFilter filter)
Get all merge requests matching the filter.
|
Pager<MergeRequest> |
MergeRequestApi.getMergeRequests(MergeRequestFilter filter,
int itemsPerPage)
Get all merge requests matching the filter.
|
List<MergeRequest> |
MergeRequestApi.getMergeRequests(MergeRequestFilter filter,
int page,
int perPage)
Get all merge requests matching the filter.
|
Milestone |
MilestonesApi.getMilestone(Integer projectId,
int milestoneId)
Get the specified milestone.
|
List<Milestone> |
MilestonesApi.getMilestones(Integer projectId)
Get a list of project milestones.
|
List<Milestone> |
MilestonesApi.getMilestones(Integer projectId,
Constants.MilestoneState state)
Get a list of project milestones that have the specified state.
|
List<Milestone> |
MilestonesApi.getMilestones(Integer projectId,
Constants.MilestoneState state,
String search)
Get a list of project milestones that have the specified state and match the search string.
|
List<Milestone> |
MilestonesApi.getMilestones(Integer projectId,
int page,
int perPage)
Get a list of project milestones.
|
List<Milestone> |
MilestonesApi.getMilestones(Integer projectId,
String search)
Get a list of project milestones that have match the search string.
|
List<Namespace> |
NamespaceApi.getNamespaces()
Get a list of the namespaces of the authenticated user.
|
Pager<Namespace> |
NamespaceApi.getNamespaces(int itemsPerPage)
Get a Pager of the namespaces of the authenticated user.
|
List<Namespace> |
NamespaceApi.getNamespaces(int page,
int perPage)
Get a list of the namespaces of the authenticated user.
|
AwardEmoji |
AwardEmojiApi.getNoteAwardEmoji(Object projectIdOrPath,
Integer issueIid,
Integer noteId,
Integer awardId)
Get the specified award emoji for the specified note.
|
List<AwardEmoji> |
AwardEmojiApi.getNoteAwardEmojis(Object projectIdOrPath,
Integer issueIid,
Integer noteId)
Get a list of award emoji for the specified note.
|
List<Note> |
NotesApi.getNotes(Integer projectId,
Integer issueIid)
Deprecated.
As of release 4.7.0, replaced by
NotesApi.getIssueNotes(Integer, Integer) |
Pager<Note> |
NotesApi.getNotes(Integer projectId,
Integer issueIid,
int itemsPerPage)
Deprecated.
As of release 4.7.0, replaced by
NotesApi.getIssueNotes(Integer, Integer, int) |
List<Note> |
NotesApi.getNotes(Integer projectId,
Integer issueIid,
int page,
int perPage)
Deprecated.
As of release 4.7.0, replaced by
NotesApi.getIssueNotes(Integer, Integer, int, int) |
Optional<Branch> |
RepositoryApi.getOptionalBranch(Object projectIdOrPath,
String branchName)
Get an Optional instance with the value for the specific repository branch.
|
Optional<Tag> |
TagsApi.getOptionalTag(Object projectIdOrPath,
String tagName)
Get an Optional instance holding a Tag instance of a specific repository tag determined by its name.
|
List<Project> |
ProjectApi.getOwnedProjects()
Get a list of projects owned by the authenticated user.
|
Pager<Project> |
ProjectApi.getOwnedProjects(int itemsPerPage)
Get a Pager of projects owned by the authenticated user.
|
List<Project> |
ProjectApi.getOwnedProjects(int page,
int perPage)
Get a list of projects owned by the authenticated user in the specified page range.
|
WikiPage |
WikisApi.getPage(Integer projectId,
String slug)
Get a single page of project wiki.
|
List<WikiPage> |
WikisApi.getPages(Integer projectId)
Get a list of pages in project wiki.
|
Pager<WikiPage> |
WikisApi.getPages(Integer projectId,
int itemsPerPage)
Get a Pager of project's wiki pages.
|
List<WikiPage> |
WikisApi.getPages(Integer projectId,
int page,
int perPage)
Get a list of project snippets.
|
List<Participant> |
MergeRequestApi.getParticipants(Integer projectId,
Integer mergeRequestIid)
Get list of participants of merge request.
|
Pager<Participant> |
MergeRequestApi.getParticipants(Integer projectId,
Integer mergeRequestIid,
int itemsPerPage)
Get a Pager of the participants of merge request.
|
List<Participant> |
MergeRequestApi.getParticipants(Integer projectId,
Integer mergeRequestIid,
int page,
int perPage)
Get list of participants of merge request and in the specified page range.
|
Pipeline |
PipelineApi.getPipeline(int projectId,
int pipelineId)
Get single pipelines in a project.
|
List<Pipeline> |
PipelineApi.getPipelines(int projectId)
Get a list of pipelines in a project.
|
List<Pipeline> |
PipelineApi.getPipelines(int projectId,
Constants.PipelineScope scope,
PipelineStatus status,
String ref,
boolean yamlErrors,
String name,
String username,
Constants.PipelineOrderBy orderBy,
Constants.SortOrder sort)
Get a list of pipelines in a project.
|
Pager<Pipeline> |
PipelineApi.getPipelines(int projectId,
Constants.PipelineScope scope,
PipelineStatus status,
String ref,
boolean yamlErrors,
String name,
String username,
Constants.PipelineOrderBy orderBy,
Constants.SortOrder sort,
int itemsPerPage)
Get a Pager of pipelines in a project.
|
List<Pipeline> |
PipelineApi.getPipelines(int projectId,
Constants.PipelineScope scope,
PipelineStatus status,
String ref,
boolean yamlErrors,
String name,
String username,
Constants.PipelineOrderBy orderBy,
Constants.SortOrder sort,
int page,
int perPage)
Get a list of pipelines in a project in the specified page range.
|
Pager<Pipeline> |
PipelineApi.getPipelines(int projectId,
int itemsPerPage)
Get a Pager of pipelines in a project.
|
List<Pipeline> |
PipelineApi.getPipelines(int projectId,
int page,
int perPage)
Get a list of pipelines in a project in the specified page range.
|
List<LicenseTemplate> |
LicensesApi.getPopularLicenseTemplates()
Get popular license templates.
|
Project |
ProjectApi.getProject(Object projectIdOrPath)
Get a specific project, which is owned by the authentication user.
|
Project |
ProjectApi.getProject(Object projectIdOrPath,
Boolean statistics)
Get a specific project, which is owned by the authentication user.
|
Project |
ProjectApi.getProject(String namespace,
String project)
Get a specific project, which is owned by the authentication user.
|
Project |
ProjectApi.getProject(String namespace,
String project,
Boolean statistics)
Get a specific project, which is owned by the authentication user.
|
List<DeployKey> |
DeployKeysApi.getProjectDeployKeys(Integer projectId)
Get a list of the deploy keys for the specified project.
|
Pager<DeployKey> |
DeployKeysApi.getProjectDeployKeys(Integer projectId,
Integer itemsPerPage)
Get a Pager of the deploy keys for the specified project.
|
List<DeployKey> |
DeployKeysApi.getProjectDeployKeys(Integer projectId,
int page,
int perPage)
Get a list of the deploy keys for the specified project using the specified page and per page settings.
|
List<Event> |
EventsApi.getProjectEvents(Integer projectId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder)
Get a list of events for the specified project.
|
Pager<Event> |
EventsApi.getProjectEvents(Integer projectId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int itemsPerPage)
Get a list of events for the specified project and in the specified page range.
|
List<Event> |
EventsApi.getProjectEvents(Integer projectId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int page,
int perPage)
Get a list of events for the specified project and in the specified page range.
|
List<Event> |
ProjectApi.getProjectEvents(Object projectIdOrPath)
Get the project events for specific project.
|
Pager<Event> |
ProjectApi.getProjectEvents(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of project events for specific project.
|
List<Event> |
ProjectApi.getProjectEvents(Object projectIdOrPath,
int page,
int perPage)
Get the project events for specific project.
|
Object |
AbstractApi.getProjectIdOrPath(Object obj)
Returns the project ID or path from the provided Integer, String, or Project instance.
|
Map<String,Float> |
ProjectApi.getProjectLanguages(Object projectIdOrPath)
Get languages used in a project with percentage value.
|
NotificationSettings |
NotificationSettingsApi.getProjectNotificationSettings(int projectId)
Get the notification settings for a project.
|
List<Runner> |
RunnersApi.getProjectRunners(Integer projectId)
List all runners (specific and shared) available in the project.
|
Pager<Runner> |
RunnersApi.getProjectRunners(Integer projectId,
int itemsPerPage)
List all runners (specific and shared) available in the project.
|
List<Project> |
ProjectApi.getProjects()
Get a list of projects accessible by the authenticated user.
|
List<Project> |
ProjectApi.getProjects(Boolean archived,
Visibility visibility,
Constants.ProjectOrderBy orderBy,
Constants.SortOrder sort,
String search,
Boolean simple,
Boolean owned,
Boolean membership,
Boolean starred,
Boolean statistics)
Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
|
Pager<Project> |
ProjectApi.getProjects(Boolean archived,
Visibility visibility,
Constants.ProjectOrderBy orderBy,
Constants.SortOrder sort,
String search,
Boolean simple,
Boolean owned,
Boolean membership,
Boolean starred,
Boolean statistics,
int itemsPerPage)
Get a Pager of projects accessible by the authenticated user and matching the supplied filter parameters.
|
List<Project> |
ProjectApi.getProjects(Boolean archived,
Visibility visibility,
Constants.ProjectOrderBy orderBy,
Constants.SortOrder sort,
String search,
Boolean simple,
Boolean owned,
Boolean membership,
Boolean starred,
Boolean statistics,
int page,
int perPage)
Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
|
List<Project> |
ProjectApi.getProjects(Boolean archived,
Visibility visibility,
String orderBy,
String sort,
String search,
Boolean simple,
Boolean owned,
Boolean membership,
Boolean starred,
Boolean statistics)
Deprecated.
Will be removed in version 5.0, replaced by
ProjectApi.getProjects(Boolean, Visibility,
Constants.ProjectOrderBy, Constants.SortOrder, String, Boolean, Boolean, Boolean, Boolean, Boolean) |
Pager<Project> |
ProjectApi.getProjects(int itemsPerPage)
Get a Pager instance of projects accessible by the authenticated user.
|
List<Project> |
GroupApi.getProjects(int groupId)
Get a list of projects belonging to the specified group ID.
|
List<Project> |
ProjectApi.getProjects(int page,
int perPage)
Get a list of projects accessible by the authenticated user and in the specified page range.
|
Pager<Project> |
GroupApi.getProjects(int groupId,
int itemsPerPage)
Get a Pager of projects belonging to the specified group ID.
|
List<Project> |
GroupApi.getProjects(int groupId,
int page,
int perPage)
Get a list of projects belonging to the specified group ID in the specified page range.
|
List<Project> |
GroupApi.getProjects(Object groupIdOrPath,
GroupProjectsFilter filter)
Get a list of projects belonging to the specified group ID and filter.
|
Pager<Project> |
GroupApi.getProjects(Object groupIdOrPath,
GroupProjectsFilter filter,
int itemsPerPage)
Get a Pager of projects belonging to the specified group ID and filter.
|
List<Project> |
ProjectApi.getProjects(String search)
Get a list of projects accessible by the authenticated user that match the provided search string.
|
Pager<Project> |
ProjectApi.getProjects(String search,
int itemsPerPage)
Get a Pager of projects accessible by the authenticated user that match the provided search string.
|
List<Project> |
ProjectApi.getProjects(String search,
int page,
int perPage)
Get a list of projects accessible by the authenticated user that match the provided search string.
|
List<ProjectUser> |
ProjectApi.getProjectUsers(Object projectIdOrPath)
Get a list of project users.
|
List<ProjectUser> |
ProjectApi.getProjectUsers(Object projectIdOrPath,
String search)
Get a list of project users matching the specified search string.
|
List<ProtectedBranch> |
ProtectedBranchesApi.getProtectedBranches(Integer projectId)
Gets a list of protected branches from a project.
|
PushRules |
ProjectApi.getPushRules(Object projectIdOrPath)
Get the project's push rules.
|
InputStream |
RepositoryApi.getRawBlobContent(Object projectIdOrPath,
String sha)
Get the raw file contents for a blob by blob SHA.
|
InputStream |
RepositoryFileApi.getRawFile(Integer projectId,
String commitOrBranchName,
String filepath)
Get the raw file contents for a file by commit sha and path.
|
File |
RepositoryFileApi.getRawFile(Integer projectId,
String commitOrBranchName,
String filepath,
File directory)
Get the raw file for the file by commit sha and path.
|
String |
ProjectApi.getRawSnippetContent(Object projectIdOrPath,
Integer snippetId)
Get the raw project snippet as plain text.
|
HealthCheckInfo |
HealthCheckApi.getReadiness()
Get Health Checks from the readiness endpoint.
|
HealthCheckInfo |
HealthCheckApi.getReadiness(String token)
Deprecated.
|
InputStream |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha)
Get an archive of the complete repository by SHA (optional).
|
InputStream |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha,
Constants.ArchiveFormat format)
Get an archive of the complete repository by SHA (optional).
|
File |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha,
File directory)
Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
|
File |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha,
File directory,
Constants.ArchiveFormat format)
Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
|
File |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha,
File directory,
String format)
Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
|
InputStream |
RepositoryApi.getRepositoryArchive(Object projectIdOrPath,
String sha,
String format)
Get an archive of the complete repository by SHA (optional).
|
RunnerDetail |
RunnersApi.getRunnerDetail(Integer runnerId)
Get details of a runner.
|
List<Runner> |
RunnersApi.getRunners()
Get a list of all available runners available to the user.
|
Pager<Runner> |
RunnersApi.getRunners(int itemsPerPage)
Get a list of all available runners available to the user.
|
List<Runner> |
RunnersApi.getRunners(int page,
int perPage)
Get a list of all available runners available to the user with pagination support.
|
List<Runner> |
RunnersApi.getRunners(Runner.RunnerStatus scope)
Get a list of all available runners available to the user with pagination support.
|
Pager<Runner> |
RunnersApi.getRunners(Runner.RunnerStatus scope,
int itemsPerPage)
Get a list of specific runners available to the user.
|
List<Runner> |
RunnersApi.getRunners(Runner.RunnerStatus scope,
Integer page,
Integer perPage)
Get a list of specific runners available to the user.
|
LicenseTemplate |
LicensesApi.getSingleLicenseTemplate(String key)
Get a single license template.
|
SlackService |
ServicesApi.getSlackService(Object projectIdOrPath)
Get the Slack notification settings for a project.
|
Snippet |
SnippetsApi.getSnippet(Integer snippetId)
Get a specific Snippet.
|
Snippet |
SnippetsApi.getSnippet(Integer snippetId,
boolean downloadContent)
Get a specific Snippet.
|
Snippet |
ProjectApi.getSnippet(Object projectIdOrPath,
Integer snippetId)
Get a single of project snippet.
|
AwardEmoji |
AwardEmojiApi.getSnippetAwardEmoji(Object projectIdOrPath,
Integer snippetId,
Integer awardId)
Get the specified award emoji for the specified snippet.
|
List<AwardEmoji> |
AwardEmojiApi.getSnippetAwardEmojis(Object projectIdOrPath,
Integer snippetId)
Get a list of award emoji for the specified snippet.
|
String |
SnippetsApi.getSnippetContent(Integer snippetId)
Get the content of a Snippet.
|
List<Snippet> |
SnippetsApi.getSnippets()
Get a list of the authenticated user's snippets.
|
List<Snippet> |
SnippetsApi.getSnippets(boolean downloadContent)
Get a list of the authenticated user's snippets.
|
Pager<Snippet> |
SnippetsApi.getSnippets(int itemsPerPage)
Get a Pager of the authenticated user's snippets.
|
List<Snippet> |
ProjectApi.getSnippets(Object projectIdOrPath)
Get a list of project snippets.
|
Pager<Snippet> |
ProjectApi.getSnippets(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of project's snippets.
|
List<Snippet> |
ProjectApi.getSnippets(Object projectIdOrPath,
int page,
int perPage)
Get a list of project snippets.
|
SshKey |
UserApi.getSshKey(Integer keyId)
Get a single SSH Key.
|
List<SshKey> |
UserApi.getSshKeys()
Get a list of currently authenticated user's SSH keys.
|
List<SshKey> |
UserApi.getSshKeys(Integer userId)
Get a list of a specified user's SSH keys.
|
List<Project> |
ProjectApi.getStarredProjects()
Get a list of projects starred by the authenticated user.
|
Pager<Project> |
ProjectApi.getStarredProjects(int itemsPerPage)
Get a Pager of projects starred by the authenticated user.
|
List<Project> |
ProjectApi.getStarredProjects(int page,
int perPage)
Get a list of projects starred by the authenticated user in the specified page range.
|
List<Group> |
GroupApi.getSubGroups(Integer groupId)
Get a list of visible direct subgroups in this group.
|
Pager<Group> |
GroupApi.getSubGroups(Integer groupId,
int itemsPerPage)
Get a Pager of visible direct subgroups in this group.
|
List<Group> |
GroupApi.getSubGroups(Integer groupId,
List<Integer> skipGroups,
Boolean allAvailable,
String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
Boolean statistics,
Boolean owned)
Get a list of visible direct subgroups in this group.
|
Pager<Group> |
GroupApi.getSubGroups(Integer groupId,
List<Integer> skipGroups,
Boolean allAvailable,
String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
Boolean statistics,
Boolean owned,
int itemsPerPage)
Get a Pager of visible direct subgroups in this group.
|
List<Group> |
GroupApi.getSubGroups(Integer groupId,
List<Integer> skipGroups,
Boolean allAvailable,
String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
Boolean statistics,
Boolean owned,
int page,
int perPage)
Get a list of visible direct subgroups in this group.
|
List<SystemHook> |
SystemHooksApi.getSystemHooks()
Get a list of all system hooks.
|
Pager<SystemHook> |
SystemHooksApi.getSystemHooks(int itemsPerPage)
Get a Pager of all system hooks.
|
List<SystemHook> |
SystemHooksApi.getSystemHooks(int page,
int perPage)
Get a list of all system hooks using the specified page and per page settings.
|
Tag |
TagsApi.getTag(Object projectIdOrPath,
String tagName)
Get a specific repository tag determined by its name.
|
List<Tag> |
TagsApi.getTags(Object projectIdOrPath)
Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
|
List<Tag> |
RepositoryApi.getTags(Object projectIdOrPath)
Deprecated.
Replaced by TagsApi.getTags(Object)
|
Pager<Tag> |
TagsApi.getTags(Object projectIdOrPath,
int itemsPerPage)
Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
|
Pager<Tag> |
RepositoryApi.getTags(Object projectIdOrPath,
int itemsPerPage)
Deprecated.
Replaced by TagsApi.getTags(Object, int)
|
List<Tag> |
TagsApi.getTags(Object projectIdOrPath,
int page,
int perPage)
Get a list of repository tags from a project, sorted by name in reverse alphabetical order and in the specified page range.
|
List<Tag> |
RepositoryApi.getTags(Object projectIdOrPath,
int page,
int perPage)
Deprecated.
Replaced by TagsApi.getTags(Object, int, int)
|
TimeStats |
IssuesApi.getTimeTrackingStats(Integer projectId,
Integer issueIid)
Get time tracking stats.
|
String |
JobApi.getTrace(Object projectIdOrPath,
int jobId)
Get a trace of a specific job of a project
GET /projects/:id/jobs/:id/trace
|
List<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath)
Get a list of repository files and directories in a project.
|
Pager<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath,
int itemsPerPage)
Get a Pager of repository files and directories in a project.
|
List<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath,
String filePath,
String refName)
Get a list of repository files and directories in a project.
|
List<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath,
String filePath,
String refName,
Boolean recursive)
Get a list of repository files and directories in a project.
|
Pager<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath,
String filePath,
String refName,
Boolean recursive,
int itemsPerPage)
Get a Pager of repository files and directories in a project.
|
Pager<TreeItem> |
RepositoryApi.getTree(Object projectIdOrPath,
String filePath,
String refName,
int itemsPerPage)
Get a Pager of repository files and directories in a project.
|
User |
UserApi.getUser(int userId)
Get a single user.
|
User |
UserApi.getUser(String username)
Lookup a user by username.
|
List<Event> |
EventsApi.getUserEvents(Integer userId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder)
Get a list of events for the specified user.
|
Pager<Event> |
EventsApi.getUserEvents(Integer userId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int itemsPerPage)
Get a list of events for the specified user and in the specified page range.
|
List<Event> |
EventsApi.getUserEvents(Integer userId,
Constants.ActionType action,
Constants.TargetType targetType,
Date before,
Date after,
Constants.SortOrder sortOrder,
int page,
int perPage)
Get a list of events for the specified user and in the specified page range.
|
Object |
AbstractApi.getUserIdOrUsername(Object obj)
Returns the user ID or path from the provided Integer, String, or User instance.
|
List<Project> |
ProjectApi.getUserProjects(Object userIdOrUsername,
ProjectFilter filter)
Get a list of visible projects owned by the given user.
|
Pager<Project> |
ProjectApi.getUserProjects(Object userIdOrUsername,
ProjectFilter filter,
int itemsPerPage)
Get a Pager of visible projects owned by the given user.
|
List<Project> |
ProjectApi.getUserProjects(Object userIdOrUsername,
ProjectFilter filter,
int page,
int perPage)
Get a list of visible projects owned by the given user in the specified page range.
|
List<User> |
UserApi.getUsers()
Get a list of users.
|
Pager<User> |
UserApi.getUsers(int itemsPerPage)
Get a Pager of users.
|
List<User> |
UserApi.getUsers(int page,
int perPage)
Get a list of users using the specified page and per page settings.
|
Version |
GitLabApi.getVersion()
Get the version info for the GitLab server using the GitLab Version API.
|
protected javax.ws.rs.core.Response |
AbstractApi.getWithAccepts(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
String accepts,
Object... pathArgs)
Perform an HTTP GET call with the specified query parameters and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
abstract void |
HookManager.handleEvent(javax.servlet.http.HttpServletRequest request)
Parses and verifies an Event instance from the HTTP request and
fires it off to the registered listeners.
|
protected javax.ws.rs.core.Response |
AbstractApi.head(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
Object... pathArgs)
Perform an HTTP HEAD call with the specified query parameters and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
List<T> |
Pager.last()
Returns the last page of List.
|
void |
GroupApi.ldapSync(Object groupIdOrPath)
Syncs the group with its linked LDAP group.
|
static GitLabApi |
GitLabApi.login(GitLabApi.ApiVersion apiVersion,
String url,
String username,
String password)
Deprecated.
As of release 4.8.7, will be removed in 4.9.0
|
static GitLabApi |
GitLabApi.login(GitLabApi.ApiVersion apiVersion,
String url,
String username,
String password,
boolean ignoreCertificateErrors)
Deprecated.
As of release 4.8.7, will be removed in 4.9.0
|
Session |
SessionApi.login(String username,
String email,
String password)
Login to get private token.
|
static GitLabApi |
GitLabApi.login(String url,
String username,
String password)
Deprecated.
As of release 4.8.7, will be removed in 4.9.0
|
static GitLabApi |
GitLabApi.login(String url,
String username,
String password,
boolean ignoreCertificateErrors)
Deprecated.
As of release 4.8.7, will be removed in 4.9.0
|
ProjectHook |
ProjectApi.modifyHook(ProjectHook hook)
Modifies a hook for project.
|
User |
UserApi.modifyUser(User user,
CharSequence password,
Integer projectsLimit)
Deprecated.
Will be removed in version 5.0, replaced by
UserApi.updateUser(User, CharSequence) |
static GitLabApi |
GitLabApi.oauth2Login(GitLabApi.ApiVersion apiVersion,
String url,
String username,
char[] password,
String secretToken,
Map<String,Object> clientConfigProperties,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(GitLabApi.ApiVersion apiVersion,
String url,
String username,
CharSequence password,
String secretToken,
Map<String,Object> clientConfigProperties,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
char[] password)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
char[] password,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
char[] password,
String secretToken,
Map<String,Object> clientConfigProperties,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
CharSequence password)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
CharSequence password,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
CharSequence password,
String secretToken,
Map<String,Object> clientConfigProperties,
boolean ignoreCertificateErrors)
Logs into GitLab using OAuth2 with the provided
username and password,
and creates a new GitLabApi instance using returned access token. |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
String password)
Deprecated.
As of release 4.8.7, replaced by
GitLabApi.oauth2Login(String, String, CharSequence), will be removed in 4.9.0 |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
String password,
boolean ignoreCertificateErrors)
Deprecated.
As of release 4.8.7, replaced by
GitLabApi.oauth2Login(String, String, CharSequence, boolean), will be removed in 4.9.0 |
static GitLabApi |
GitLabApi.oauth2Login(String url,
String username,
String password,
String secretToken,
Map<String,Object> clientConfigProperties,
boolean ignoreCertificateErrors)
Deprecated.
As of release 4.8.7, will be removed in 4.9.0
|
static <T> T |
GitLabApi.orElseThrow(Optional<T> optional)
Return the Optional instances contained value, if present, otherwise throw the exception that is
associated with the Optional instance.
|
Job |
JobApi.playJob(Object projectIdOrPath,
int jobId)
Play specified job in a project.
|
protected javax.ws.rs.core.Response |
AbstractApi.post(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.Form formData,
Object... pathArgs)
Perform an HTTP POST call with the specified form data and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.post(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.Form formData,
URL url)
Perform an HTTP POST call with the specified form data and URL, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.post(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
Object... pathArgs)
Perform an HTTP POST call with the specified form data and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.post(javax.ws.rs.core.Response.Status expectedStatus,
Object payload,
Object... pathArgs)
Perform an HTTP POST call with the specified payload object and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.post(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.StreamingOutput stream,
String mediaType,
Object... pathArgs)
Perform an HTTP POST call with the specified payload object and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
List<T> |
Pager.previous()
Returns the previous page of List.
|
ProtectedBranch |
ProtectedBranchesApi.protectBranch(Integer projectId,
String branchName)
Protects a single repository branch or several project repository branches using a wildcard protected branch.
|
ProtectedBranch |
ProtectedBranchesApi.protectBranch(Integer projectId,
String branchName,
AccessLevel pushAccessLevel,
AccessLevel mergeAccessLevel)
Protects a single repository branch or several project repository branches using a wildcard protected branch.
|
Branch |
RepositoryApi.protectBranch(Object projectIdOrPath,
String branchName)
Protects a single project repository branch.
|
protected javax.ws.rs.core.Response |
AbstractApi.put(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
Object... pathArgs)
Perform an HTTP PUT call with the specified form data and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.put(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
URL url)
Perform an HTTP PUT call with the specified form data and URL, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.putWithFormData(javax.ws.rs.core.Response.Status expectedStatus,
javax.ws.rs.core.Form formData,
Object... pathArgs)
Perform an HTTP PUT call with the specified form data and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
RunnerDetail |
RunnersApi.registerRunner(String token,
String description,
Boolean active,
List<String> tagList,
Boolean runUntagged,
Boolean locked,
Integer maximumTimeout)
Register a new runner for the gitlab instance.
|
EpicIssue |
EpicsApi.removeIssue(Object groupIdOrPath,
Integer epicIid,
Integer issueIid)
Remove an epic - issue association.
|
void |
GroupApi.removeMember(Integer groupId,
Integer userId)
Removes member from the group.
|
void |
ProjectApi.removeMember(Object projectIdOrPath,
Integer userId)
Removes user from project team.
|
void |
RunnersApi.removeRunner(Integer runnerId)
Remove a runner.
|
TimeStats |
IssuesApi.resetEstimatedTime(Integer projectId,
Integer issueIid)
Resets the estimated time for this issue to 0 seconds.
|
TimeStats |
IssuesApi.resetSpentTime(Integer projectId,
Integer issueIid)
Resets the total spent time for this issue to 0 seconds.
|
Job |
JobApi.retryJob(Object projectIdOrPath,
int jobId)
Retry specified job in a project.
|
Pipeline |
PipelineApi.retryPipelineJob(int projectId,
int pipelineId)
Retry a job in specified pipelines in a project.
|
void |
UserApi.revokeImpersonationToken(Integer userId,
Integer tokenId)
Revokes an impersonation token.
|
void |
ServicesApi.setGitLabCI(Object projectIdOrPath,
String token,
String projectCIUrl)
Deprecated.
No longer supported
|
void |
ServicesApi.setHipChat(Object projectIdOrPath,
String token,
String room,
String server)
Deprecated.
replaced with
updateHipChat method |
void |
GitLabApi.setSudoAsId(Integer sudoAsId)
Sets up all future calls to the GitLab API to be done as another user specified by provided user ID.
|
void |
ProjectApi.shareProject(Object projectIdOrPath,
Integer groupId,
AccessLevel accessLevel,
Date expiresAt)
Share a project with the specified group.
|
Project |
ProjectApi.starProject(Object projectIdOrPath)
Star a project.
|
Stream<T> |
Pager.stream()
Builds and returns a Stream instance for streaming all the items from each page.
|
Label |
LabelsApi.subscribeLabel(Integer projectId,
Integer labelId)
Subscribe a specified label
|
void |
GitLabApi.sudo(String sudoAsUsername)
Sets up all future calls to the GitLab API to be done as another user specified by sudoAsUsername.
|
void |
SystemHooksApi.testSystemHook(Integer hookId)
Test a system hook.
|
void |
SystemHooksApi.testSystemHook(SystemHook hook)
Test a system hook.
|
Project |
ProjectApi.transferProject(Object projectIdOrPath,
String namespace)
Transfer a project to a new namespace.
|
MergeRequest |
MergeRequestApi.unapproveMergeRequest(Integer projectId,
Integer mergeRequestIid)
Unapprove a merge request.
|
Project |
ProjectApi.unarchiveProject(Object projectIdOrPath)
Unarchive a project
POST /projects/:id/unarchive
|
void |
UserApi.unblockUser(Integer userId)
Unblocks the specified user.
|
void |
ProtectedBranchesApi.unprotectBranch(Integer projectId,
String branchName)
Unprotects the given protected branch or wildcard protected branch.
|
Branch |
RepositoryApi.unprotectBranch(Object projectIdOrPath,
String branchName)
Unprotects a single project repository branch.
|
void |
ProjectApi.unshareProject(Object projectIdOrPath,
Integer groupId)
Unshare the project from the group.
|
Project |
ProjectApi.unstarProject(Object projectIdOrPath)
Unstar a project.
|
Label |
LabelsApi.unsubscribeLabel(Integer projectId,
Integer labelId)
Unsubscribe a specified label
|
Epic |
EpicsApi.updateEpic(Object groupIdOrPath,
Integer epicIid,
Epic epic)
Updates an epic using the information contained in the provided Epic instance.
|
Epic |
EpicsApi.updateEpic(Object groupIdOrPath,
Integer epicIid,
String title,
String labels,
String description,
Date startDate,
Date endDate)
Updates an existing epic.
|
ExternalWikiService |
ServicesApi.updateExternalWikiService(Object projectIdOrPath,
ExternalWikiService externalWiki)
Updates the ExternalWikiService service settings for a project.
|
RepositoryFile |
RepositoryFileApi.updateFile(RepositoryFile file,
Integer projectId,
String branchName,
String commitMessage)
Update existing file in repository
PUT /projects/:id/repository/files
file_path (required) - Full path to new file.
|
NotificationSettings |
NotificationSettingsApi.updateGlobalNotificationSettings(NotificationSettings settings)
Update the global notification settings.
|
Group |
GroupApi.updateGroup(Group group)
Updates a project group.
|
Group |
GroupApi.updateGroup(Integer groupId,
String name,
String path,
String description,
Boolean membershipLock,
Boolean shareWithGroupLock,
Visibility visibility,
Boolean lfsEnabled,
Boolean requestAccessEnabled,
Integer parentId,
Integer sharedRunnersMinutesLimit)
Deprecated.
Will be removed in version 5.0, replaced by
GroupApi.updateGroup(Integer, String, String, String,
Visibility, Boolean, Boolean, Integer) |
Group |
GroupApi.updateGroup(Integer groupId,
String name,
String path,
String description,
Visibility visibility,
Boolean lfsEnabled,
Boolean requestAccessEnabled,
Integer parentId)
Updates a project group.
|
NotificationSettings |
NotificationSettingsApi.updateGroupNotificationSettings(int groupId,
NotificationSettings settings)
Update the notification settings for a group
PUT /groups/:id/notification_settings
|
HipChatService |
ServicesApi.updateHipChatService(Object projectIdOrPath,
HipChatService hipChat)
Updates the HipChatService notification settings for a project.
|
Issue |
IssuesApi.updateIssue(Integer projectId,
Integer issueIid,
String title,
String description,
Boolean confidential,
List<Integer> assigneeIds,
Integer milestoneId,
String labels,
Constants.StateEvent stateEvent,
Date updatedAt,
Date dueDate)
Updates an existing project issue.
|
EpicIssue |
EpicsApi.updateIssue(Object groupIdOrPath,
Integer epicIid,
Integer issueIid,
Integer moveBeforeId,
Integer moveAfterId)
Updates an epic - issue association.
|
Note |
NotesApi.updateIssueNote(Integer projectId,
Integer issueIid,
Integer noteId,
String body)
Update the specified issues's note.
|
JiraService |
ServicesApi.updateJiraService(Object projectIdOrPath,
JiraService jira)
Updates the JIRA service settings for a project.
|
Label |
LabelsApi.updateLabel(Integer projectId,
String name,
String newName,
String color,
String description,
Integer priority)
Update the specified label
|
Label |
LabelsApi.updateLabelColor(Integer projectId,
String name,
String color,
String description,
Integer priority)
Update the specified label
|
Label |
LabelsApi.updateLabelName(Integer projectId,
String name,
String newName,
String description,
Integer priority)
Update the specified label
|
Member |
GroupApi.updateMember(Integer groupId,
Integer userId,
AccessLevel accessLevel)
Updates a member of a group.
|
Member |
GroupApi.updateMember(Integer groupId,
Integer userId,
AccessLevel accessLevel,
Date expiresAt)
Updates a member of a group.
|
Member |
GroupApi.updateMember(Integer groupId,
Integer userId,
Integer accessLevel)
Updates a member of a group.
|
Member |
GroupApi.updateMember(Integer groupId,
Integer userId,
Integer accessLevel,
Date expiresAt)
Updates a member of a group.
|
Member |
ProjectApi.updateMember(Object projectIdOrPath,
Integer userId,
AccessLevel accessLevel)
Updates a member of a project.
|
Member |
ProjectApi.updateMember(Object projectIdOrPath,
Integer userId,
AccessLevel accessLevel,
Date expiresAt)
Updates a member of a project.
|
Member |
ProjectApi.updateMember(Object projectIdOrPath,
Integer userId,
Integer accessLevel)
Updates a member of a project.
|
Member |
ProjectApi.updateMember(Object projectIdOrPath,
Integer userId,
Integer accessLevel,
Date expiresAt)
Updates a member of a project.
|
protected MergeRequest |
MergeRequestApi.updateMergeRequest(Integer projectId,
Integer mergeRequestIid,
javax.ws.rs.core.Form formData) |
MergeRequest |
MergeRequestApi.updateMergeRequest(Integer projectId,
Integer mergeRequestIid,
String targetBranch,
String title,
Integer assigneeId,
String description,
Constants.StateEvent stateEvent,
String labels,
Integer milestoneId)
Deprecated.
|
MergeRequest |
MergeRequestApi.updateMergeRequest(Integer projectId,
Integer mergeRequestIid,
String targetBranch,
String title,
Integer assigneeId,
String description,
Constants.StateEvent stateEvent,
String labels,
Integer milestoneId,
Boolean removeSourceBranch,
Boolean squash,
Boolean discussionLocked,
Boolean allowCollaboration)
Updates an existing merge request.
|
MergeRequest |
MergeRequestApi.updateMergeRequest(Integer projectId,
Integer mergeRequestIid,
String sourceBranch,
String targetBranch,
String title,
String description,
Integer assigneeId)
Deprecated.
as of release 4.4.3
|
Note |
NotesApi.updateMergeRequestNote(Integer projectId,
Integer mergeRequestIid,
Integer noteId,
String body)
Update the specified merge request's note.
|
Milestone |
MilestonesApi.updateMilestone(Integer projectId,
Integer milestoneId,
String title,
String description,
Date dueDate,
Date startDate,
Constants.MilestoneState milestoneState)
Update the specified milestone.
|
WikiPage |
WikisApi.updatePage(Integer projectId,
String slug,
String title,
String content)
Updates an existing project wiki page.
|
Project |
ProjectApi.updateProject(Project project)
Updates a project.
|
NotificationSettings |
NotificationSettingsApi.updateProjectNotificationSettings(int projectId,
NotificationSettings settings)
Update the notification settings for a project
PUT /projects/:id/notification_settings
|
PushRules |
ProjectApi.updatePushRules(Object projectIdOrPath,
PushRules pushRule)
Updates a push rule for the specified project.
|
Release |
TagsApi.updateRelease(Object projectIdOrPath,
String tagName,
String releaseNotes)
Updates the release notes of a given release.
|
RunnerDetail |
RunnersApi.updateRunner(Integer runnerId,
String description,
Boolean active,
List<String> tagList,
Boolean runUntagged,
Boolean locked,
RunnerDetail.RunnerAccessLevel accessLevel)
Update details of a runner.
|
SlackService |
ServicesApi.updateSlackService(Object projectIdOrPath,
SlackService slackNotifications)
Updates the Slack notification settings for a project.
|
Snippet |
ProjectApi.updateSnippet(Object projectIdOrPath,
Integer snippetId,
String title,
String filename,
String description,
String code,
Visibility visibility)
Updates an existing project snippet.
|
User |
UserApi.updateUser(User user,
CharSequence password)
Modifies an existing user.
|
protected javax.ws.rs.core.Response |
AbstractApi.upload(javax.ws.rs.core.Response.Status expectedStatus,
String name,
File fileToUpload,
String mediaType,
Object... pathArgs)
Perform a file upload with the specified File instance and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
protected javax.ws.rs.core.Response |
AbstractApi.upload(javax.ws.rs.core.Response.Status expectedStatus,
String name,
File fileToUpload,
String mediaType,
URL url)
Perform a file upload with the specified File instance and path objects, returning
a ClientResponse instance with the data returned from the endpoint.
|
FileUpload |
ProjectApi.uploadFile(Object projectIdOrPath,
File fileToUpload)
Uploads a file to the specified project to be used in an issue or merge request description, or a comment.
|
FileUpload |
ProjectApi.uploadFile(Object projectIdOrPath,
File fileToUpload,
String mediaType)
Uploads a file to the specified project to be used in an issue or merge request description, or a comment.
|
protected String |
AbstractApi.urlEncode(String s)
Encode a string to be used as in-path argument for a gitlab api request.
|
protected javax.ws.rs.core.Response |
AbstractApi.validate(javax.ws.rs.core.Response response,
javax.ws.rs.core.Response.Status expected)
Validates response the response from the server against the expected HTTP status and
the returned secret token, if either is not correct will throw a GitLabApiException.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SystemHookManager.fireEvent(SystemHookEvent event)
Fire the event to the registered listeners.
|
void |
SystemHookManager.handleEvent(javax.servlet.http.HttpServletRequest request)
Parses and verifies an SystemHookEvent instance from the HTTP request and
fires it off to the registered listeners.
|
void |
SystemHookManager.handleEvent(SystemHookEvent event)
Verifies the provided Event and fires it off to the registered listeners.
|
| Modifier and Type | Method and Description |
|---|---|
void |
WebHookManager.fireEvent(Event event)
Fire the event to the registered listeners.
|
void |
WebHookManager.handleEvent(Event event)
Verifies the provided Event and fires it off to the registered listeners.
|
void |
WebHookManager.handleEvent(javax.servlet.http.HttpServletRequest request)
Parses and verifies an Event instance from the HTTP request and
fires it off to the registered listeners.
|
Copyright © 2018. All rights reserved.