Package 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.

Nested Class Summary

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

Constants.ActionType, Constants.GroupOrderBy, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestState, Constants.MilestoneState, 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	Description
MilestonesApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
Milestone	activateMilestone(Integer projectId, Integer milestoneId)	Activate a milestone.
Milestone	closeMilestone(Integer projectId, Integer milestoneId)	Close a milestone.
Milestone	createMilestone(Integer projectId, String title, String description, Date dueDate, Date startDate)	Create a milestone.
List<Issue>	getIssues(Integer projectId, Integer milestoneId)	Get the list of issues associated with the specified milestone.
List<MergeRequest>	getMergeRequest(Integer projectId, Integer milestoneId)	Get the list of merge requests associated with the specified milestone.
Milestone	getMilestone(Integer projectId, int milestoneId)	Get the specified milestone.
List<Milestone>	getMilestones(Integer projectId)	Get a list of project milestones.
List<Milestone>	getMilestones(Integer projectId, int page, int perPage)	Get a list of project milestones.
List<Milestone>	getMilestones(Integer projectId, String search)	Get a list of project milestones that have match the search string.
List<Milestone>	getMilestones(Integer projectId, Constants.MilestoneState state)	Get a list of project milestones that have the specified state.
List<Milestone>	getMilestones(Integer projectId, Constants.MilestoneState state, String search)	Get a list of project milestones that have the specified state and match the search string.
Milestone	updateMilestone(Integer projectId, 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, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, 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

MilestonesApi

public MilestonesApi(GitLabApi gitLabApi)

Method Detail

getMilestones

public List<Milestone> getMilestones(Integer projectId)
                              throws GitLabApiException

Get a list of project milestones.

Parameters:

projectId - the project ID to get the milestones for

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

public List<Milestone> getMilestones(Integer projectId,
                                     int page,
                                     int perPage)
                              throws GitLabApiException

Get a list of project milestones.

Parameters:

projectId - the project ID to get the milestones for

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 List<Milestone> getMilestones(Integer projectId,
                                     Constants.MilestoneState state)
                              throws GitLabApiException

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

Parameters:

projectId - the project ID to get the milestones for

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

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

Parameters:

projectId - the project ID to get the milestones for

search - the search string

Returns:

the milestones associated with the specified project

Throws:

GitLabApiException - if any exception occurs

getMilestones

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

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

Parameters:

projectId - the project ID to get the milestones for

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

Get the specified milestone.

Parameters:

projectId - the project ID to get the milestone for

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

Get the list of issues associated with the specified milestone.

Parameters:

projectId - the project ID to get the milestone issues for

milestoneId - the milestone ID to get the issues for

Returns:

a List of Issue for the milestone

Throws:

GitLabApiException - if any exception occurs

getMergeRequest

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

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

Parameters:

projectId - the project ID to get the milestone merge requests for

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(Integer projectId,
                                 String title,
                                 String description,
                                 Date dueDate,
                                 Date startDate)
                          throws GitLabApiException

Create a milestone.

Parameters:

projectId - the project ID to create a milestone for

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

Close a milestone.

Parameters:

projectId - the project ID of the milestone

milestoneId - the milestone ID to close

Returns:

the closed Milestone instance

Throws:

GitLabApiException - if any exception occurs

activateMilestone

public Milestone activateMilestone(Integer projectId,
                                   Integer milestoneId)
                            throws GitLabApiException

Activate a milestone.

Parameters:

projectId - the project ID of the milestone

milestoneId - the milestone ID to activate

Returns:

the activated Milestone instance

Throws:

GitLabApiException - if any exception occurs

updateMilestone

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

Update the specified milestone.

Parameters:

projectId - the project ID of the milestone

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