org.gitlab4j.api

Class IssuesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.IssuesApi

All Implemented Interfaces:

Constants

public class IssuesApi
extends AbstractApi
implements Constants

This class provides an entry point to all the GitLab API Issue calls.

See Also:

Issues API at GitLab, Issue Links API at GitLab, Issues Statistics API at GitLab

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.StateEvent, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

Fields inherited from interface org.gitlab4j.api.Constants

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

Constructor Summary

Constructors

Constructor and Description
IssuesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
TimeStats	addSpentTime(Object projectIdOrPath, Integer issueIid, Duration duration) Adds spent time for this issue
TimeStats	addSpentTime(Object projectIdOrPath, Integer issueIid, int duration) Adds spent time for this issue
TimeStats	addSpentTime(Object projectIdOrPath, Integer issueIid, String duration) Adds spent time for this issue
Issue	assignIssue(Object projectIdOrPath, Integer issueIid, Integer assigneeId) Updates an existing project issue.
Issue	closeIssue(Object projectIdOrPath, Integer issueIid) Closes an existing project issue.
Issue	createIssue(Object projectIdOrPath, String title, String description) Create an issue for the project.
Issue	createIssue(Object projectIdOrPath, 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.
IssueLink	createIssueLink(Object projectIdOrPath, Integer issueIid, Object targetProjectIdOrPath, Integer targetIssueIid) Creates a two-way relation between two issues.
void	deleteIssue(Object projectIdOrPath, Integer issueIid) Delete an issue.
IssueLink	deleteIssueLink(Object projectIdOrPath, Integer issueIid, Integer issueLinkId) Deletes an issue link, thus removes the two-way relationship.
TimeStats	estimateTime(Object projectIdOrPath, Integer issueIid, Duration duration) Sets an estimated time of work in this issue
TimeStats	estimateTime(Object projectIdOrPath, Integer issueIid, int duration) Sets an estimated time of work in this issue
TimeStats	estimateTime(Object projectIdOrPath, Integer issueIid, String duration) Sets an estimated time of work in this issue
List<MergeRequest>	getClosedByMergeRequests(Object projectIdOrPath, Integer issueIid) Get list containing all the merge requests that will close issue when merged.
Pager<MergeRequest>	getClosedByMergeRequests(Object projectIdOrPath, Integer issueIid, int itemsPerPage) Get a Pager containing all the merge requests that will close issue when merged.
List<MergeRequest>	getClosedByMergeRequests(Object projectIdOrPath, Integer issueIid, int page, int perPage) Get list containing all the merge requests that will close issue when merged.
Stream<MergeRequest>	getClosedByMergeRequestsStream(Object projectIdOrPath, Integer issueIid) Get list containing all the merge requests that will close issue when merged.
List<Issue>	getGroupIssues(Object groupIdOrPath) Get a list of a group’s issues.
Pager<Issue>	getGroupIssues(Object groupIdOrPath, int itemsPerPage) Get a Pager of groups's issues.
List<Issue>	getGroupIssues(Object groupIdOrPath, IssueFilter filter) Get a list of a group’s issues.
Pager<Issue>	getGroupIssues(Object groupIdOrPath, IssueFilter filter, int itemsPerPage) Get a list of groups's issues.
IssuesStatistics	getGroupIssuesStatistics(Object groupIdOrPath, IssuesStatisticsFilter filter) Gets issues count statistics for given group.
Stream<Issue>	getGroupIssuesStream(Object groupIdOrPath) Get a Stream of a group’s issues.
Stream<Issue>	getGroupIssuesStream(Object groupIdOrPath, IssueFilter filter) Get a Stream of a group’s issues.
Issue	getIssue(Object projectIdOrPath, Integer issueIid) Get a single project issue.
List<Issue>	getIssueLinks(Object projectIdOrPath, Integer issueIid) Get a list of related issues of a given issue, sorted by the relationship creation datetime (ascending).
Pager<Issue>	getIssueLinks(Object projectIdOrPath, Integer issueIid, int itemsPerPage) Get a Pager of related issues of a given issue, sorted by the relationship creation datetime (ascending).
Stream<Issue>	getIssueLinksStream(Object projectIdOrPath, Integer issueIid) Get a Stream of related issues of a given issue, sorted by the relationship creation datetime (ascending).
List<Issue>	getIssues() Get all issues the authenticated user has access to.
Pager<Issue>	getIssues(int itemsPerPage) Get a Pager of all issues the authenticated user has access to.
List<Issue>	getIssues(int page, int perPage) Get all issues the authenticated user has access to using the specified page and per page setting.
List<Issue>	getIssues(IssueFilter filter) Get all issues the authenticated user has access to.
Pager<Issue>	getIssues(IssueFilter filter, int itemsPerPage) Get all issues the authenticated user has access to.
List<Issue>	getIssues(IssueFilter filter, int page, int perPage) Get all issues the authenticated user has access to.
List<Issue>	getIssues(Object projectIdOrPath) Get a list of project's issues.
Pager<Issue>	getIssues(Object projectIdOrPath, int itemsPerPage) Get a Pager of project's issues.
List<Issue>	getIssues(Object projectIdOrPath, int page, int perPage) Get a list of project's issues using the specified page and per page settings.
List<Issue>	getIssues(Object projectIdOrPath, IssueFilter filter) Get a list of project's issues.
Pager<Issue>	getIssues(Object projectIdOrPath, IssueFilter filter, int itemsPerPage) Get a list of project's issues.
List<Issue>	getIssues(Object projectIdOrPath, IssueFilter filter, int page, int perPage) Get a list of project's issues.
IssuesStatistics	getIssuesStatistics(IssuesStatisticsFilter filter) Gets issues count statistics on all issues the authenticated user has access to.
Stream<Issue>	getIssuesStream() Get all issues the authenticated user has access to as a Stream.
Stream<Issue>	getIssuesStream(IssueFilter filter) Get all issues the authenticated user has access to.
Stream<Issue>	getIssuesStream(Object projectIdOrPath) Get a Stream of project's issues.
Stream<Issue>	getIssuesStream(Object projectIdOrPath, IssueFilter filter) Get a Stream of project's issues.
Optional<Issue>	getOptionalIssue(Object projectIdOrPath, Integer issueIid) Get a single project issue as an Optional instance.
Optional<TimeStats>	getOptionalTimeTrackingStats(Object projectIdOrPath, Integer issueIid) Get time tracking stats as an Optional instance
List<Participant>	getParticipants(Object projectIdOrPath, Integer issueIid) Get list of participants for an issue.
Pager<Participant>	getParticipants(Object projectIdOrPath, Integer issueIid, int itemsPerPage) Get a Pager of the participants for an issue.
List<Participant>	getParticipants(Object projectIdOrPath, Integer issueIid, int page, int perPage) Get list of participants for an issue and in the specified page range.
Stream<Participant>	getParticipantsStream(Object projectIdOrPath, Integer issueIid) Get Stream of participants for an issue.
TimeStats	getTimeTrackingStats(Object projectIdOrPath, Integer issueIid) Get time tracking stats.
Issue	moveIssue(Object projectIdOrPath, Integer issueIid, Object toProjectId) Moves an issue to a different project.
TimeStats	resetEstimatedTime(Object projectIdOrPath, Integer issueIid) Resets the estimated time for this issue to 0 seconds.
TimeStats	resetSpentTime(Object projectIdOrPath, Integer issueIid) Resets the total spent time for this issue to 0 seconds.
Issue	updateIssue(Object projectIdOrPath, 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.

Methods inherited from class org.gitlab4j.api.AbstractApi

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IssuesApi

public IssuesApi(GitLabApi gitLabApi)

Method Detail

getIssues

public List<Issue> getIssues()
                      throws GitLabApiException

Get all issues the authenticated user has access to. Only returns issues created by the current user.

GitLab Endpoint: GET /issues

Returns:

a list of user's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(int page,
                             int perPage)
                      throws GitLabApiException

Get all issues the authenticated user has access to using the specified page and per page setting. Only returns issues created by the current user.

GitLab Endpoint: GET /issues

Parameters:

page - the page to get

perPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssues

public Pager<Issue> getIssues(int itemsPerPage)
                       throws GitLabApiException

Get a Pager of all issues the authenticated user has access to. Only returns issues created by the current user.

GitLab Endpoint: GET /issues

r

Parameters:

itemsPerPage - the number of issues per page

Returns:

the Pager of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssuesStream

public Stream<Issue> getIssuesStream()
                              throws GitLabApiException

Get all issues the authenticated user has access to as a Stream. Only returns issues created by the current user.

GitLab Endpoint: GET /issues

Returns:

a Stream of user's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Object projectIdOrPath)
                      throws GitLabApiException

Get a list of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

Returns:

a list of project's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Object projectIdOrPath,
                             int page,
                             int perPage)
                      throws GitLabApiException

Get a list of project's issues using the specified page and per page settings.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

page - the page to get

perPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssues

public Pager<Issue> getIssues(Object projectIdOrPath,
                              int itemsPerPage)
                       throws GitLabApiException

Get a Pager of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

itemsPerPage - the number of issues per page

Returns:

the Pager of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssuesStream

public Stream<Issue> getIssuesStream(Object projectIdOrPath)
                              throws GitLabApiException

Get a Stream of project's issues. Only returns the first page

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

Returns:

a Stream of project's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Object projectIdOrPath,
                             IssueFilter filter)
                      throws GitLabApiException

Get a list of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

filter - IssueFilter a IssueFilter instance with the filter settings

Returns:

the list of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Object projectIdOrPath,
                             IssueFilter filter,
                             int page,
                             int perPage)
                      throws GitLabApiException

Get a list of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

filter - IssueFilter a IssueFilter instance with the filter settings.

page - the page to get.

perPage - the number of projects per page.

Returns:

the list of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssues

public Pager<Issue> getIssues(Object projectIdOrPath,
                              IssueFilter filter,
                              int itemsPerPage)
                       throws GitLabApiException

Get a list of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

filter - IssueFilter a IssueFilter instance with the filter settings.

itemsPerPage - the number of Project instances that will be fetched per page.

Returns:

the Pager of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssuesStream

public Stream<Issue> getIssuesStream(Object projectIdOrPath,
                                     IssueFilter filter)
                              throws GitLabApiException

Get a Stream of project's issues.

GitLab Endpoint: GET /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

filter - IssueFilter a IssueFilter instance with the filter settings

Returns:

a Stream of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(IssueFilter filter)
                      throws GitLabApiException

Get all issues the authenticated user has access to. By default it returns only issues created by the current user.

GitLab Endpoint: GET /issues

Parameters:

filter - IssueFilter a IssueFilter instance with the filter settings

Returns:

the list of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(IssueFilter filter,
                             int page,
                             int perPage)
                      throws GitLabApiException

Get all issues the authenticated user has access to. By default it returns only issues created by the current user.

GitLab Endpoint: GET /issues

Parameters:

filter - IssueFilter a IssueFilter instance with the filter settings.

page - the page to get.

perPage - the number of projects per page.

Returns:

the list of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssues

public Pager<Issue> getIssues(IssueFilter filter,
                              int itemsPerPage)
                       throws GitLabApiException

Get all issues the authenticated user has access to. By default it returns only issues created by the current user.

GitLab Endpoint: GET /issues

Parameters:

filter - IssueFilter a IssueFilter instance with the filter settings.

itemsPerPage - the number of Project instances that will be fetched per page.

Returns:

the Pager of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getIssuesStream

public Stream<Issue> getIssuesStream(IssueFilter filter)
                              throws GitLabApiException

Get all issues the authenticated user has access to. By default it returns only issues created by the current user.

GitLab Endpoint: GET /issues

Parameters:

filter - IssueFilter a IssueFilter instance with the filter settings

Returns:

the Stream of issues in the specified range.

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

public List<Issue> getGroupIssues(Object groupIdOrPath)
                           throws GitLabApiException

Get a list of a group’s issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

Returns:

a List of issues for the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

public Pager<Issue> getGroupIssues(Object groupIdOrPath,
                                   int itemsPerPage)
                            throws GitLabApiException

Get a Pager of groups's issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

itemsPerPage - the number of Issue instances that will be fetched per page.

Returns:

the Pager of issues for the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupIssuesStream

public Stream<Issue> getGroupIssuesStream(Object groupIdOrPath)
                                   throws GitLabApiException

Get a Stream of a group’s issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

Returns:

a Stream of issues for the specified group and filter

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

public List<Issue> getGroupIssues(Object groupIdOrPath,
                                  IssueFilter filter)
                           throws GitLabApiException

Get a list of a group’s issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

filter - IssueFilter a IssueFilter instance with the filter settings.

Returns:

a List of issues for the specified group and filter

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

public Pager<Issue> getGroupIssues(Object groupIdOrPath,
                                   IssueFilter filter,
                                   int itemsPerPage)
                            throws GitLabApiException

Get a list of groups's issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

filter - IssueFilter a IssueFilter instance with the filter settings.

itemsPerPage - the number of Issue instances that will be fetched per page.

Returns:

the Pager of issues for the specified group and filter

Throws:

GitLabApiException - if any exception occurs

getGroupIssuesStream

public Stream<Issue> getGroupIssuesStream(Object groupIdOrPath,
                                          IssueFilter filter)
                                   throws GitLabApiException

Get a Stream of a group’s issues.

GitLab Endpoint: GET /groups/:id/issues

Parameters:

groupIdOrPath - the group in the form of an Integer(ID), String(path), or Group instance

filter - IssueFilter a IssueFilter instance with the filter settings.

Returns:

a Stream of issues for the specified group and filter

Throws:

GitLabApiException - if any exception occurs

getIssue

public Issue getIssue(Object projectIdOrPath,
                      Integer issueIid)
               throws GitLabApiException

Get a single project issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

the specified Issue instance

Throws:

GitLabApiException - if any exception occurs

getOptionalIssue

public Optional<Issue> getOptionalIssue(Object projectIdOrPath,
                                        Integer issueIid)

Get a single project issue as an Optional instance.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

the specified Issue as an Optional instance

createIssue

public Issue createIssue(Object projectIdOrPath,
                         String title,
                         String description)
                  throws GitLabApiException

Create an issue for the project.

GitLab Endpoint: POST /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

title - the title of an issue, required

description - the description of an issue, optional

Returns:

an instance of Issue

Throws:

GitLabApiException - if any exception occurs

createIssue

public Issue createIssue(Object projectIdOrPath,
                         String title,
                         String description,
                         Boolean confidential,
                         List<Integer> assigneeIds,
                         Integer milestoneId,
                         String labels,
                         Date createdAt,
                         Date dueDate,
                         Integer mergeRequestToResolveId,
                         Integer discussionToResolveId)
                  throws GitLabApiException

Create an issue for the project.

GitLab Endpoint: POST /projects/:id/issues

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

title - the issue title of an issue, required

description - the description of an issue, optional

confidential - set the issue to be confidential, default is false, optional

assigneeIds - the IDs of the users to assign issue, optional

milestoneId - the ID of a milestone to assign issue, optional

labels - comma-separated label names for an issue, optional

createdAt - the date the issue was created at, optional

dueDate - the due date, optional

mergeRequestToResolveId - the IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values. Optional

discussionToResolveId - the ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with merge_request_to_resolve_discussions_of. Optional

Returns:

an instance of Issue

Throws:

GitLabApiException - if any exception occurs

closeIssue

public Issue closeIssue(Object projectIdOrPath,
                        Integer issueIid)
                 throws GitLabApiException

Closes an existing project issue.

GitLab Endpoint: PUT /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the issue IID to update, required

Returns:

an instance of the updated Issue

Throws:

GitLabApiException - if any exception occurs

updateIssue

public Issue updateIssue(Object projectIdOrPath,
                         Integer issueIid,
                         String title,
                         String description,
                         Boolean confidential,
                         List<Integer> assigneeIds,
                         Integer milestoneId,
                         String labels,
                         Constants.StateEvent stateEvent,
                         Date updatedAt,
                         Date dueDate)
                  throws GitLabApiException

Updates an existing project issue. This call can also be used to mark an issue as closed.

GitLab Endpoint: PUT /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the issue IID to update, required

title - the title of an issue, optional

description - the description of an issue, optional

confidential - set the issue to be confidential, default is false, optional

assigneeIds - the IDs of the users to assign issue, optional

milestoneId - the ID of a milestone to assign issue, optional

labels - comma-separated label names for an issue, optional

stateEvent - the state event of an issue. Set close to close the issue and reopen to reopen it, optional

updatedAt - sets the updated date, requires admin or project owner rights, optional

dueDate - the due date, optional

Returns:

an instance of the updated Issue

Throws:

GitLabApiException - if any exception occurs

assignIssue

public Issue assignIssue(Object projectIdOrPath,
                         Integer issueIid,
                         Integer assigneeId)
                  throws GitLabApiException

Updates an existing project issue. This call can also be used to mark an issue as closed.

GitLab Endpoint: PUT /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the issue IID to update, required

assigneeId - the ID of the user to assign issue to, required

Returns:

an instance of the updated Issue

Throws:

GitLabApiException - if any exception occurs

deleteIssue

public void deleteIssue(Object projectIdOrPath,
                        Integer issueIid)
                 throws GitLabApiException

Delete an issue.

GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the internal ID of a project's issue

Throws:

GitLabApiException - if any exception occurs

estimateTime

public TimeStats estimateTime(Object projectIdOrPath,
                              Integer issueIid,
                              int duration)
                       throws GitLabApiException

Sets an estimated time of work in this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the internal ID of a project's issue

duration - estimated time in seconds

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

estimateTime

public TimeStats estimateTime(Object projectIdOrPath,
                              Integer issueIid,
                              String duration)
                       throws GitLabApiException

Sets an estimated time of work in this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the internal ID of a project's issue

duration - Human readable format, e.g. 3h30m

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

estimateTime

public TimeStats estimateTime(Object projectIdOrPath,
                              Integer issueIid,
                              Duration duration)
                       throws GitLabApiException

Sets an estimated time of work in this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

duration - set the estimate of time to this duration

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

resetEstimatedTime

public TimeStats resetEstimatedTime(Object projectIdOrPath,
                                    Integer issueIid)
                             throws GitLabApiException

Resets the estimated time for this issue to 0 seconds.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/reset_time_estimate

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

addSpentTime

public TimeStats addSpentTime(Object projectIdOrPath,
                              Integer issueIid,
                              int duration)
                       throws GitLabApiException

Adds spent time for this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

duration - the duration in seconds

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

addSpentTime

public TimeStats addSpentTime(Object projectIdOrPath,
                              Integer issueIid,
                              String duration)
                       throws GitLabApiException

Adds spent time for this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

duration - Human readable format, e.g. 3h30m

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

addSpentTime

public TimeStats addSpentTime(Object projectIdOrPath,
                              Integer issueIid,
                              Duration duration)
                       throws GitLabApiException

Adds spent time for this issue

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

duration - the duration of time spent

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

resetSpentTime

public TimeStats resetSpentTime(Object projectIdOrPath,
                                Integer issueIid)
                         throws GitLabApiException

Resets the total spent time for this issue to 0 seconds.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/reset_spent_time

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

getTimeTrackingStats

public TimeStats getTimeTrackingStats(Object projectIdOrPath,
                                      Integer issueIid)
                               throws GitLabApiException

Get time tracking stats.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/time_stats

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a TimeStats instance

Throws:

GitLabApiException - if any exception occurs

getOptionalTimeTrackingStats

public Optional<TimeStats> getOptionalTimeTrackingStats(Object projectIdOrPath,
                                                        Integer issueIid)

Get time tracking stats as an Optional instance

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/time_stats

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a TimeStats as an Optional instance

getClosedByMergeRequests

public List<MergeRequest> getClosedByMergeRequests(Object projectIdOrPath,
                                                   Integer issueIid)
                                            throws GitLabApiException

Get list containing all the merge requests that will close issue when merged.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_by

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the internal ID of a project's issue

Returns:

a List containing all the merge requests what will close the issue when merged.

Throws:

GitLabApiException - if any exception occurs

getClosedByMergeRequests

public List<MergeRequest> getClosedByMergeRequests(Object projectIdOrPath,
                                                   Integer issueIid,
                                                   int page,
                                                   int perPage)
                                            throws GitLabApiException

Get list containing all the merge requests that will close issue when merged.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_by

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the internal ID of a project's issue

page - the page to get

perPage - the number of issues per page

Returns:

a List containing all the merge requests what will close the issue when merged.

Throws:

GitLabApiException - if any exception occurs

getClosedByMergeRequests

public Pager<MergeRequest> getClosedByMergeRequests(Object projectIdOrPath,
                                                    Integer issueIid,
                                                    int itemsPerPage)
                                             throws GitLabApiException

Get a Pager containing all the merge requests that will close issue when merged.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_by

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the internal ID of a project's issue

itemsPerPage - the number of Issue instances that will be fetched per page

Returns:

a Pager containing all the issues that would be closed by merging the provided merge request

Throws:

GitLabApiException - if any exception occurs

getClosedByMergeRequestsStream

public Stream<MergeRequest> getClosedByMergeRequestsStream(Object projectIdOrPath,
                                                           Integer issueIid)
                                                    throws GitLabApiException

Get list containing all the merge requests that will close issue when merged.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/closed_by

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the internal ID of a project's issue

Returns:

a List containing all the merge requests what will close the issue when merged.

Throws:

GitLabApiException - if any exception occurs

getIssueLinks

public List<Issue> getIssueLinks(Object projectIdOrPath,
                                 Integer issueIid)
                          throws GitLabApiException

Get a list of related issues of a given issue, sorted by the relationship creation datetime (ascending). Issues will be filtered according to the user authorizations.

NOTE: Only available in GitLab Starter, GitLab Bronze, and higher tiers.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/links

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a list of related issues of a given issue, sorted by the relationship creation datetime (ascending)

Throws:

GitLabApiException - if any exception occurs

getIssueLinks

public Pager<Issue> getIssueLinks(Object projectIdOrPath,
                                  Integer issueIid,
                                  int itemsPerPage)
                           throws GitLabApiException

Get a Pager of related issues of a given issue, sorted by the relationship creation datetime (ascending). Issues will be filtered according to the user authorizations.

NOTE: Only available in GitLab Starter, GitLab Bronze, and higher tiers.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/links

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

itemsPerPage - the number of issues per page

Returns:

a Pager of related issues of a given issue, sorted by the relationship creation datetime (ascending)

Throws:

GitLabApiException - if any exception occurs

getIssueLinksStream

public Stream<Issue> getIssueLinksStream(Object projectIdOrPath,
                                         Integer issueIid)
                                  throws GitLabApiException

Get a Stream of related issues of a given issue, sorted by the relationship creation datetime (ascending). Issues will be filtered according to the user authorizations.

NOTE: Only available in GitLab Starter, GitLab Bronze, and higher tiers.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/links

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

Returns:

a Stream of related issues of a given issue, sorted by the relationship creation datetime (ascending)

Throws:

GitLabApiException - if any exception occurs

createIssueLink

public IssueLink createIssueLink(Object projectIdOrPath,
                                 Integer issueIid,
                                 Object targetProjectIdOrPath,
                                 Integer targetIssueIid)
                          throws GitLabApiException

Creates a two-way relation between two issues. User must be allowed to update both issues in order to succeed.

NOTE: Only available in GitLab Starter, GitLab Bronze, and higher tiers.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/links

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue

targetProjectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance of the target project

targetIssueIid - the internal ID of a target project’s issue

Returns:

an instance of IssueLink holding the link relationship

Throws:

GitLabApiException - if any exception occurs

deleteIssueLink

public IssueLink deleteIssueLink(Object projectIdOrPath,
                                 Integer issueIid,
                                 Integer issueLinkId)
                          throws GitLabApiException

Deletes an issue link, thus removes the two-way relationship.

NOTE: Only available in GitLab Starter, GitLab Bronze, and higher tiers.

GitLab Endpoint: POST /projects/:id/issues/:issue_iid/links/:issue_link_id

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the internal ID of a project's issue, required

issueLinkId - the ID of an issue relationship, required

Returns:

an instance of IssueLink holding the deleted link relationship

Throws:

GitLabApiException - if any exception occurs

getParticipants

public List<Participant> getParticipants(Object projectIdOrPath,
                                         Integer issueIid)
                                  throws GitLabApiException

Get list of participants for an issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/participants

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the IID of the issue to get the participants for

Returns:

a List containing all participants for the specified issue

Throws:

GitLabApiException - if any exception occurs

getParticipants

public List<Participant> getParticipants(Object projectIdOrPath,
                                         Integer issueIid,
                                         int page,
                                         int perPage)
                                  throws GitLabApiException

Get list of participants for an issue and in the specified page range.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/participants

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the IID of the issue to get the participants for

page - the page to get

perPage - the number of projects per page

Returns:

a List containing all participants for the specified issue

Throws:

GitLabApiException - if any exception occurs

getParticipants

public Pager<Participant> getParticipants(Object projectIdOrPath,
                                          Integer issueIid,
                                          int itemsPerPage)
                                   throws GitLabApiException

Get a Pager of the participants for an issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/participants

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the IID of the issue to get the participants for

itemsPerPage - the number of Participant instances that will be fetched per page

Returns:

a Pager containing all participants for the specified issue

Throws:

GitLabApiException - if any exception occurs

getParticipantsStream

public Stream<Participant> getParticipantsStream(Object projectIdOrPath,
                                                 Integer issueIid)
                                          throws GitLabApiException

Get Stream of participants for an issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/participants

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance

issueIid - the IID of the issue to get the participants for

Returns:

a Stream containing all participants for the specified issue

Throws:

GitLabApiException - if any exception occurs

getIssuesStatistics

public IssuesStatistics getIssuesStatistics(IssuesStatisticsFilter filter)
                                     throws GitLabApiException

Gets issues count statistics on all issues the authenticated user has access to. By default it returns only issues created by the current user. To get all issues, use parameter scope=all.

GitLab Endpoint: GET /issues_statistics

Parameters:

filter - IssuesStatisticsFilter a IssuesStatisticsFilter instance with the filter settings.

Returns:

an IssuesStatistics instance with the statistics for the matched issues.

Throws:

GitLabApiException - if any exception occurs

getGroupIssuesStatistics

public IssuesStatistics getGroupIssuesStatistics(Object groupIdOrPath,
                                                 IssuesStatisticsFilter filter)
                                          throws GitLabApiException

Gets issues count statistics for given group.

GitLab Endpoint: GET /groups/:groupId/issues_statistics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path, required

filter - IssuesStatisticsFilter a IssuesStatisticsFilter instance with the filter settings

Returns:

an IssuesStatistics instance with the statistics for the matched issues

Throws:

GitLabApiException - if any exception occurs

moveIssue

public Issue moveIssue(Object projectIdOrPath,
                       Integer issueIid,
                       Object toProjectId)
                throws GitLabApiException

Moves an issue to a different project. If the target project equals the source project or the user has insufficient permissions to move an issue, error 400 together with an explaining error message is returned.

If a given label and/or milestone with the same name also exists in the target project, it will then be assigned to the issue that is being moved.

GitLab Endpoint: POST /projects/:projectId/issues/:issue_iid/move

Parameters:

projectIdOrPath - the project in the form of an Integer(ID), String(path), or Project instance, required

issueIid - the IID of the issue to move

toProjectId - the ID of the project to move the issue to

Returns:

an Issue instance for the moved issue

Throws:

GitLabApiException - if any exception occurs