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.

Nested Class Summary

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

Constants.ActionType, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

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(Integer projectId, Integer issueIid, Duration duration) Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time
TimeStats	addSpentTime(Integer projectId, Integer issueIid, int duration) Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time
TimeStats	addSpentTime(Integer projectId, Integer issueIid, String duration) Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time
Issue	closeIssue(Integer projectId, Integer issueIid) Closes an existing project issue.
Issue	createIssue(Integer projectId, String title, String description) Create an issue for the project.
Issue	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.
void	deleteIssue(Integer projectId, Integer issueIid) Delete an issue.
TimeStats	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	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	estimateTime(Integer projectId, Integer issueIid, String duration) Sets an estimated time of work in this issue POST /projects/:id/issues/:issue_iid/time_estimate
Issue	getIssue(Integer projectId, Integer issueId) Get a single project issue.
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(Integer projectId) Get a list of project's issues.
Pager<Issue>	getIssues(Integer projectId, int itemsPerPage) Get a Pager of project's issues.
List<Issue>	getIssues(Integer projectId, int page, int perPage) Get a list of project's issues using the specified page and per page settings.
List<Issue>	getIssues(int page, int perPage) Get all issues the authenticated user has access to using the specified page and per page setting.
TimeStats	getTimeTrackingStats(Integer projectId, Integer issueIid) Get time tracking stats GET /projects/:id/issues/:issue_iid/time_stats
TimeStats	resetEstimatedTime(Integer projectId, Integer issueIid) Resets the estimated time for this issue to 0 seconds.
TimeStats	resetSpentTime(Integer projectId, Integer issueIid) Resets the total spent time for this issue to 0 seconds.
Issue	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.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, post, post, put, put, putWithFormData, 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. Only returns the first page 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. 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. GET /issues r

Parameters:

itemsPerPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Integer projectId)
                      throws GitLabApiException

Get a list of project's issues. Only returns the first page GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

Returns:

a list of project's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

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

Get a list of project's issues using the specified page and per page settings. GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

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(Integer projectId,
                              int itemsPerPage)
                       throws GitLabApiException

Get a Pager of project's issues. GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

itemsPerPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssue

public Issue getIssue(Integer projectId,
                      Integer issueId)
               throws GitLabApiException

Get a single project issue. GET /projects/:id/issues/:issue_iid

Parameters:

projectId - the project ID to get the issue for

issueId - the internal ID of a project's issue

Returns:

the specified Issue instance

Throws:

GitLabApiException - if any exception occurs

createIssue

public Issue createIssue(Integer projectId,
                         String title,
                         String description)
                  throws GitLabApiException

Create an issue for the project. POST /projects/:id/issues

Parameters:

projectId - the ID of the project owned by the authenticated user, required

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(Integer projectId,
                         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. POST /projects/:id/issues

Parameters:

projectId - the ID of the project owned by the authenticated user, required

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(Integer projectId,
                        Integer issueIid)
                 throws GitLabApiException

Closes an existing project issue. PUT /projects/:id/issues/:issue_iid

Parameters:

projectId - the ID of the project owned by the authenticated user, 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(Integer projectId,
                         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. PUT /projects/:id/issues/:issue_iid

Parameters:

projectId - the ID of the project owned by the authenticated user, 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

deleteIssue

public void deleteIssue(Integer projectId,
                        Integer issueIid)
                 throws GitLabApiException

Delete an issue. DELETE /projects/:id/issues/:issue_iid

Parameters:

projectId - the project ID to delete the issue from

issueIid - the internal ID of a project's issue

Throws:

GitLabApiException - if any exception occurs

estimateTime

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

Sets an estimated time of work in this issue POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectId - the project ID that owns the issue

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(Integer projectId,
                              Integer issueIid,
                              String duration)
                       throws GitLabApiException

Sets an estimated time of work in this issue POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectId - the project ID that owns the issue

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(Integer projectId,
                              Integer issueIid,
                              Duration duration)
                       throws GitLabApiException

Sets an estimated time of work in this issue POST /projects/:id/issues/:issue_iid/time_estimate

Parameters:

projectId - the project ID that owns the issue

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(Integer projectId,
                                    Integer issueIid)
                             throws GitLabApiException

Resets the estimated time for this issue to 0 seconds. POST /projects/:id/issues/:issue_iid/reset_time_estimate

Parameters:

projectId - the project ID that owns the issue

issueIid - the internal ID of a project's issue

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

addSpentTime

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

Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectId - the project ID that owns the issue

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(Integer projectId,
                              Integer issueIid,
                              String duration)
                       throws GitLabApiException

Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectId - the project ID to delete the issue from

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(Integer projectId,
                              Integer issueIid,
                              Duration duration)
                       throws GitLabApiException

Adds spent time for this issue POST /projects/:id/issues/:issue_iid/add_spent_time

Parameters:

projectId - the project ID to delete the issue from

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(Integer projectId,
                                Integer issueIid)
                         throws GitLabApiException

Resets the total spent time for this issue to 0 seconds. POST /projects/:id/issues/:issue_iid/reset_spent_time

Parameters:

projectId - the project ID that owns the issue

issueIid - the internal ID of a project's issue

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs

getTimeTrackingStats

public TimeStats getTimeTrackingStats(Integer projectId,
                                      Integer issueIid)
                               throws GitLabApiException

Get time tracking stats GET /projects/:id/issues/:issue_iid/time_stats

Parameters:

projectId - the project ID that owns the issue

issueIid - the internal ID of a project's issue

Returns:

a TimeSTats instance

Throws:

GitLabApiException - if any exception occurs