org.gitlab4j.api

Class MilestonesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.MilestonesApi

All Implemented Interfaces:

Constants

public class MilestonesApi
extends AbstractApi

This class implements the client side API for the GitLab milestones calls.

See Also:

Project milestones API, Group milestones API

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.DeploymentStatus, 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
MilestonesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Milestone	activateGroupMilestone(Object groupIdOrPath, Integer milestoneId) Activate a group milestone.
Milestone	activateMilestone(Object projectIdOrPath, Integer milestoneId) Activate a milestone.
Milestone	closeGroupMilestone(Object groupIdOrPath, Integer milestoneId) Close a group milestone.
Milestone	closeMilestone(Object projectIdOrPath, Integer milestoneId) Close a milestone.
Milestone	createGroupMilestone(Object groupIdOrPath, String title, String description, Date dueDate, Date startDate) Create a group milestone.
Milestone	createMilestone(Object projectIdOrPath, String title, String description, Date dueDate, Date startDate) Create a milestone.
void	deleteMilestone(Object projectIdOrPath, Integer milestoneId) Delete a project milestone.
List<Issue>	getGroupIssues(Object groupIdOrPath, Integer milestoneId) Get the list of issues associated with the specified group milestone.
Pager<Issue>	getGroupIssues(Object groupIdOrPath, Integer milestoneId, int itemsPerPage) Get the Pager of issues associated with the specified group milestone.
Stream<Issue>	getGroupIssuesStream(Object groupIdOrPath, Integer milestoneId) Get a Stream of issues associated with the specified group milestone.
List<MergeRequest>	getGroupMergeRequest(Object groupIdOrPath, Integer milestoneId) Get the list of merge requests associated with the specified group milestone.
Milestone	getGroupMilestone(Object groupIdOrPath, Integer milestoneId) Get the specified group milestone.
List<Milestone>	getGroupMilestones(Object groupIdOrPath) Get a list of group milestones.
List<Milestone>	getGroupMilestones(Object groupIdOrPath, Constants.MilestoneState state) Get a list of group milestones that have the specified state.
List<Milestone>	getGroupMilestones(Object groupIdOrPath, Constants.MilestoneState state, String search) Get a list of group milestones that have the specified state and match the search string.
Pager<Milestone>	getGroupMilestones(Object groupIdOrPath, int itemsPerPage) Get a Page of group milestones.
List<Milestone>	getGroupMilestones(Object groupIdOrPath, int page, int perPage) Get a list of group milestones.
List<Milestone>	getGroupMilestones(Object groupIdOrPath, String search) Get a list of group milestones that have match the search string.
Stream<Milestone>	getGroupMilestonesStream(Object groupIdOrPath) Get a Stream of group milestones.
List<Issue>	getIssues(Object projectIdOrPath, Integer milestoneId) Get the list of issues associated with the specified milestone.
Pager<Issue>	getIssues(Object projectIdOrPath, Integer milestoneId, int itemsPerPage) Get a Pager of issues associated with the specified milestone.
Stream<Issue>	getIssuesStream(Object projectIdOrPath, Integer milestoneId) Get a Stream of issues associated with the specified milestone.
List<MergeRequest>	getMergeRequest(Object projectIdOrPath, Integer milestoneId) Get the list of merge requests associated with the specified milestone.
Milestone	getMilestone(Object projectIdOrPath, Integer milestoneId) Get the specified milestone.
List<Milestone>	getMilestones(Object projectIdOrPath) Get a list of project milestones.
List<Milestone>	getMilestones(Object projectIdOrPath, Constants.MilestoneState state) Get a list of project milestones that have the specified state.
List<Milestone>	getMilestones(Object projectIdOrPath, Constants.MilestoneState state, String search) Get a list of project milestones that have the specified state and match the search string.
Pager<Milestone>	getMilestones(Object projectIdOrPath, int itemsPerPage) Get a Pager of project milestones.
List<Milestone>	getMilestones(Object projectIdOrPath, int page, int perPage) Get a list of project milestones.
List<Milestone>	getMilestones(Object projectIdOrPath, String search) Get a list of project milestones that have match the search string.
Stream<Milestone>	getMilestonesStream(Object projectIdOrPath) Get a Stream of project milestones.
Milestone	updateGroupMilestone(Object groupIdOrPath, Integer milestoneId, String title, String description, Date dueDate, Date startDate, Constants.MilestoneState milestoneState) Update the specified group milestone.
Milestone	updateMilestone(Object projectIdOrPath, Integer milestoneId, String title, String description, Date dueDate, Date startDate, Constants.MilestoneState milestoneState) Update the specified milestone.

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

MilestonesApi

public MilestonesApi(GitLabApi gitLabApi)

Method Detail

getGroupMilestones

public List<Milestone> getGroupMilestones(Object groupIdOrPath)
                                   throws GitLabApiException

Get a list of group milestones.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

Returns:

the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestones

public List<Milestone> getGroupMilestones(Object groupIdOrPath,
                                          int page,
                                          int perPage)
                                   throws GitLabApiException

Get a list of group milestones.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

page - the page number to get

perPage - how many milestones per page

Returns:

the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestones

public Pager<Milestone> getGroupMilestones(Object groupIdOrPath,
                                           int itemsPerPage)
                                    throws GitLabApiException

Get a Page of group milestones.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

itemsPerPage - The number of Milestone instances that will be fetched per page

Returns:

the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestonesStream

public Stream<Milestone> getGroupMilestonesStream(Object groupIdOrPath)
                                           throws GitLabApiException

Get a Stream of group milestones.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

Returns:

a Stream of the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestones

public List<Milestone> getGroupMilestones(Object groupIdOrPath,
                                          Constants.MilestoneState state)
                                   throws GitLabApiException

Get a list of group milestones that have the specified state.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

state - the milestone state

Returns:

the milestones associated with the specified group and state

Throws:

GitLabApiException - if any exception occurs

getGroupMilestones

public List<Milestone> getGroupMilestones(Object groupIdOrPath,
                                          String search)
                                   throws GitLabApiException

Get a list of group milestones that have match the search string.

GitLab Endpoint: GET /groups/:id/milestones

Parameters:

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

search - the search string

Returns:

the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestones

public List<Milestone> getGroupMilestones(Object groupIdOrPath,
                                          Constants.MilestoneState state,
                                          String search)
                                   throws GitLabApiException

Get a list of group milestones that have the specified state and match the search string.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id

Parameters:

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

state - the milestone state

search - the search string

Returns:

the milestones associated with the specified group

Throws:

GitLabApiException - if any exception occurs

getGroupMilestone

public Milestone getGroupMilestone(Object groupIdOrPath,
                                   Integer milestoneId)
                            throws GitLabApiException

Get the specified group milestone.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the ID of the milestone tp get

Returns:

a Milestone instance for the specified IDs

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

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

Get the list of issues associated with the specified group milestone.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

Returns:

a List of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getGroupIssues

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

Get the Pager of issues associated with the specified group milestone.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

itemsPerPage - The number of Milestone instances that will be fetched per page

Returns:

a Pager of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getGroupIssuesStream

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

Get a Stream of issues associated with the specified group milestone.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

Returns:

a Stream of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getGroupMergeRequest

public List<MergeRequest> getGroupMergeRequest(Object groupIdOrPath,
                                               Integer milestoneId)
                                        throws GitLabApiException

Get the list of merge requests associated with the specified group milestone.

GitLab Endpoint: GET /groups/:id/milestones/:milestone_id/merge_requests

Parameters:

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

milestoneId - the milestone ID to get the merge requests for

Returns:

a list of merge requests associated with the specified milestone

Throws:

GitLabApiException - if any exception occurs

createGroupMilestone

public Milestone createGroupMilestone(Object groupIdOrPath,
                                      String title,
                                      String description,
                                      Date dueDate,
                                      Date startDate)
                               throws GitLabApiException

Create a group milestone.

GitLab Endpoint: POST /groups/:id/milestones

Parameters:

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

title - the title for the milestone

description - the description for the milestone

dueDate - the due date for the milestone

startDate - the start date for the milestone

Returns:

the created Milestone instance

Throws:

GitLabApiException - if any exception occurs

closeGroupMilestone

public Milestone closeGroupMilestone(Object groupIdOrPath,
                                     Integer milestoneId)
                              throws GitLabApiException

Close a group milestone.

GitLab Endpoint: PUT /groups/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to close

Returns:

the closed Milestone instance

Throws:

GitLabApiException - if any exception occurs

activateGroupMilestone

public Milestone activateGroupMilestone(Object groupIdOrPath,
                                        Integer milestoneId)
                                 throws GitLabApiException

Activate a group milestone.

GitLab Endpoint: PUT /groups/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to activate

Returns:

the activated Milestone instance

Throws:

GitLabApiException - if any exception occurs

updateGroupMilestone

public Milestone updateGroupMilestone(Object groupIdOrPath,
                                      Integer milestoneId,
                                      String title,
                                      String description,
                                      Date dueDate,
                                      Date startDate,
                                      Constants.MilestoneState milestoneState)
                               throws GitLabApiException

Update the specified group milestone.

GitLab Endpoint: PUT /groups/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to update

title - the updated title for the milestone

description - the updated description for the milestone

dueDate - the updated due date for the milestone

startDate - the updated start date for the milestone

milestoneState - the updated milestone state

Returns:

the updated Milestone instance

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Object projectIdOrPath)
                              throws GitLabApiException

Get a list of project milestones.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Object projectIdOrPath,
                                     int page,
                                     int perPage)
                              throws GitLabApiException

Get a list of project milestones.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

page - the page number to get

perPage - how many milestones per page

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

public Pager<Milestone> getMilestones(Object projectIdOrPath,
                                      int itemsPerPage)
                               throws GitLabApiException

Get a Pager of project milestones.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

itemsPerPage - The number of Milestone instances that will be fetched per page

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestonesStream

public Stream<Milestone> getMilestonesStream(Object projectIdOrPath)
                                      throws GitLabApiException

Get a Stream of project milestones.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

Returns:

a Stream of the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Object projectIdOrPath,
                                     Constants.MilestoneState state)
                              throws GitLabApiException

Get a list of project milestones that have the specified state.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

state - the milestone state

Returns:

the milestones associated with the specified project and state

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Object projectIdOrPath,
                                     String search)
                              throws GitLabApiException

Get a list of project milestones that have match the search string.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

search - the search string

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Object projectIdOrPath,
                                     Constants.MilestoneState state,
                                     String search)
                              throws GitLabApiException

Get a list of project milestones that have the specified state and match the search string.

GitLab Endpoint: GET /projects/:id/milestones

Parameters:

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

state - the milestone state

search - the search string

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestone

public Milestone getMilestone(Object projectIdOrPath,
                              Integer milestoneId)
                       throws GitLabApiException

Get the specified milestone.

GitLab Endpoint: GET /projects/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the ID of the milestone tp get

Returns:

a Milestone instance for the specified IDs

Throws:

GitLabApiException - if any exception occurs

getIssues

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

Get the list of issues associated with the specified milestone.

GitLab Endpoint: GET /projects/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

Returns:

a List of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getIssues

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

Get a Pager of issues associated with the specified milestone.

GitLab Endpoint: GET /projects/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

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

Returns:

a Pager of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getIssuesStream

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

Get a Stream of issues associated with the specified milestone.

GitLab Endpoint: GET /projects/:id/milestones/:milestone_id/issues

Parameters:

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

milestoneId - the milestone ID to get the issues for

Returns:

a Stream of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getMergeRequest

public List<MergeRequest> getMergeRequest(Object projectIdOrPath,
                                          Integer milestoneId)
                                   throws GitLabApiException

Get the list of merge requests associated with the specified milestone.

GitLab Endpoint: GET /projects/:id/milestones/:milestone_id/merge_requests

Parameters:

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

milestoneId - the milestone ID to get the merge requests for

Returns:

a list of merge requests associated with the specified milestone

Throws:

GitLabApiException - if any exception occurs

createMilestone

public Milestone createMilestone(Object projectIdOrPath,
                                 String title,
                                 String description,
                                 Date dueDate,
                                 Date startDate)
                          throws GitLabApiException

Create a milestone.

GitLab Endpoint: POST /projects/:id/milestones

Parameters:

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

title - the title for the milestone

description - the description for the milestone

dueDate - the due date for the milestone

startDate - the start date for the milestone

Returns:

the created Milestone instance

Throws:

GitLabApiException - if any exception occurs

closeMilestone

public Milestone closeMilestone(Object projectIdOrPath,
                                Integer milestoneId)
                         throws GitLabApiException

Close a milestone.

GitLab Endpoint: PUT /projects/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to close

Returns:

the closed Milestone instance

Throws:

GitLabApiException - if any exception occurs

activateMilestone

public Milestone activateMilestone(Object projectIdOrPath,
                                   Integer milestoneId)
                            throws GitLabApiException

Activate a milestone.

GitLab Endpoint: PUT /projects/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to activate

Returns:

the activated Milestone instance

Throws:

GitLabApiException - if any exception occurs

updateMilestone

public Milestone updateMilestone(Object projectIdOrPath,
                                 Integer milestoneId,
                                 String title,
                                 String description,
                                 Date dueDate,
                                 Date startDate,
                                 Constants.MilestoneState milestoneState)
                          throws GitLabApiException

Update the specified milestone.

GitLab Endpoint: PUT /projects/:id/milestones/:milestone_id

Parameters:

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

milestoneId - the milestone ID to update

title - the updated title for the milestone

description - the updated description for the milestone

dueDate - the updated due date for the milestone

startDate - the updated start date for the milestone

milestoneState - the updated milestone state

Returns:

the updated Milestone instance

Throws:

GitLabApiException - if any exception occurs

deleteMilestone

public void deleteMilestone(Object projectIdOrPath,
                            Integer milestoneId)
                     throws GitLabApiException

Delete a project milestone.

Parameters:

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

milestoneId - the milestone ID to delete

Throws:

GitLabApiException - if any exception occurs