Package org.gitlab4j.api

Class MergeRequestApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.MergeRequestApi

All Implemented Interfaces:

Constants

public class MergeRequestApi
extends AbstractApi

This class implements the client side API for the GitLab merge request 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
MergeRequestApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method	Description
MergeRequest	acceptMergeRequest(Integer projectId, Integer mergeRequestIid)	Merge changes to the merge request.
MergeRequest	acceptMergeRequest(Integer projectId, Integer mergeRequestIid, String mergeCommitMessage, Boolean shouldRemoveSourceBranch, Boolean mergeWhenPipelineSucceeds)	Merge changes to the merge request.
MergeRequest	acceptMergeRequest(Integer projectId, Integer mergeRequestIid, String mergeCommitMessage, Boolean shouldRemoveSourceBranch, Boolean mergeWhenPipelineSucceeds, String sha)	Merge changes to the merge request.
MergeRequest	approveMergeRequest(Integer projectId, Integer mergeRequestIid, String sha)	Approve a merge request.
MergeRequest	cancelMergeRequest(Integer projectId, Integer mergeRequestIid)	Cancel merge when pipeline succeeds.
MergeRequest	createMergeRequest(Integer projectId, String sourceBranch, String targetBranch, String title, String description, Integer assigneeId)	Creates a merge request and optionally assigns a reviewer to it.
void	deleteMergeRequest(Integer projectId, Integer mergeRequestIid)	Only for admins and project owners.
List<Commit>	getCommits(int projectId, int mergeRequestIid)	Get a list of merge request commits.
Pager<Commit>	getCommits(int projectId, int mergeRequestIid, int itemsPerPage)	Get a Pager of merge request commits.
List<Commit>	getCommits(int projectId, int mergeRequestIid, int page, int perPage)	Get a list of merge request commits.
MergeRequest	getMergeRequest(Integer projectId, Integer mergeRequestIid)	Get information about a single merge request.
MergeRequest	getMergeRequestApprovals(Integer projectId, Integer mergeRequestIid)	Get the merge request with approval information.
List<MergeRequest>	getMergeRequests(Integer projectId)	Get all merge requests for the specified project.
Pager<MergeRequest>	getMergeRequests(Integer projectId, int itemsPerPage)	Get all merge requests for the specified project.
List<MergeRequest>	getMergeRequests(Integer projectId, int page, int perPage)	Get all merge requests for the specified project.
List<MergeRequest>	getMergeRequests(Integer projectId, Constants.MergeRequestState state)	Get all merge requests with a specific state for the specified project.
Pager<MergeRequest>	getMergeRequests(Integer projectId, Constants.MergeRequestState state, int itemsPerPage)	Get all merge requests for the specified project.
List<MergeRequest>	getMergeRequests(Integer projectId, Constants.MergeRequestState state, int page, int perPage)	Get all merge requests for the specified project.
Optional<MergeRequest>	getOptionalMergeRequest(Integer projectId, Integer mergeRequestIid)	Get information about a single merge request as an Optional instance.
MergeRequest	unapproveMergeRequest(Integer projectId, Integer mergeRequestIid)	Unapprove a merge request.
MergeRequest	updateMergeRequest(Integer projectId, Integer mergeRequestIid, String targetBranch, String title, Integer assigneeId, String description, Constants.StateEvent stateEvent, String labels, Integer milestoneId)	Updates an existing merge request.
MergeRequest	updateMergeRequest(Integer projectId, Integer mergeRequestIid, String sourceBranch, String targetBranch, String title, String description, Integer assigneeId)	Deprecated. as of release 4.4.3

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

MergeRequestApi

public MergeRequestApi(GitLabApi gitLabApi)

Method Detail

getMergeRequests

public List<MergeRequest> getMergeRequests(Integer projectId)
                                    throws GitLabApiException

Get all merge requests for the specified project. GET /projects/:id/merge_requests

Parameters:

projectId - the project ID to get the merge requests for

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequests

public List<MergeRequest> getMergeRequests(Integer projectId,
                                           int page,
                                           int perPage)
                                    throws GitLabApiException

Get all merge requests for the specified project. GET /projects/:id/merge_requests

Parameters:

projectId - the project ID to get the merge requests for

page - the page to get

perPage - the number of MergeRequest instances per page

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequests

public Pager<MergeRequest> getMergeRequests(Integer projectId,
                                            int itemsPerPage)
                                     throws GitLabApiException

Get all merge requests for the specified project. GET /projects/:id/merge_requests

Parameters:

projectId - the project ID to get the merge requests for

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

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequests

public List<MergeRequest> getMergeRequests(Integer projectId,
                                           Constants.MergeRequestState state)
                                    throws GitLabApiException

Get all merge requests with a specific state for the specified project. GET /projects/:id/merge_requests?state=:state

Parameters:

projectId - the project ID to get the merge requests for

state - the state parameter can be used to get only merge requests with a given state (opened, closed, or merged) or all of them (all).

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequests

public List<MergeRequest> getMergeRequests(Integer projectId,
                                           Constants.MergeRequestState state,
                                           int page,
                                           int perPage)
                                    throws GitLabApiException

Get all merge requests for the specified project. GET /projects/:id/merge_requests

Parameters:

projectId - the project ID to get the merge requests for

state - the state parameter can be used to get only merge requests with a given state (opened, closed, or merged) or all of them (all).

page - the page to get

perPage - the number of MergeRequest instances per page

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequests

public Pager<MergeRequest> getMergeRequests(Integer projectId,
                                            Constants.MergeRequestState state,
                                            int itemsPerPage)
                                     throws GitLabApiException

Get all merge requests for the specified project. GET /projects/:id/merge_requests

Parameters:

projectId - the project ID to get the merge requests for

state - the state parameter can be used to get only merge requests with a given state (opened, closed, or merged) or all of them (all).

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

Returns:

all merge requests for the specified project

Throws:

GitLabApiException - if any exception occurs

getMergeRequest

public MergeRequest getMergeRequest(Integer projectId,
                                    Integer mergeRequestIid)
                             throws GitLabApiException

Get information about a single merge request.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

GET /projects/:id/merge_requests/:merge_request_id

Parameters:

projectId - the project ID of the merge request

mergeRequestIid - the internal ID of the merge request

Returns:

the specified MergeRequest instance

Throws:

GitLabApiException - if any exception occurs

getOptionalMergeRequest

public Optional<MergeRequest> getOptionalMergeRequest(Integer projectId,
                                                      Integer mergeRequestIid)

Get information about a single merge request as an Optional instance.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

GET /projects/:id/merge_requests/:merge_request_id

Parameters:

projectId - the project ID of the merge request

mergeRequestIid - the internal ID of the merge request

Returns:

the specified MergeRequest as an Optional instance instance

getCommits

public List<Commit> getCommits(int projectId,
                               int mergeRequestIid)
                        throws GitLabApiException

Get a list of merge request commits.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

GET /projects/:id/merge_requests/:merge_request_iid/commits

Parameters:

projectId - the project ID for the merge request

mergeRequestIid - the internal ID of the merge request

Returns:

a list containing the commits for the specified merge request

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

getCommits

public List<Commit> getCommits(int projectId,
                               int mergeRequestIid,
                               int page,
                               int perPage)
                        throws GitLabApiException

Get a list of merge request commits.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

GET /projects/:id/merge_requests/:merge_request_iid/commits

Parameters:

projectId - the project ID for the merge request

mergeRequestIid - the internal ID of the merge request

page - the page to get

perPage - the number of commits per page

Returns:

a list containing the commits for the specified merge request

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

getCommits

public Pager<Commit> getCommits(int projectId,
                                int mergeRequestIid,
                                int itemsPerPage)
                         throws GitLabApiException

Get a Pager of merge request commits.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

GET /projects/:id/merge_requests/:merge_request_iid/commits

Parameters:

projectId - the project ID for the merge request

mergeRequestIid - the internal ID of the merge request

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

Returns:

a Pager containing the commits for the specified merge request

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

createMergeRequest

public MergeRequest createMergeRequest(Integer projectId,
                                       String sourceBranch,
                                       String targetBranch,
                                       String title,
                                       String description,
                                       Integer assigneeId)
                                throws GitLabApiException

Creates a merge request and optionally assigns a reviewer to it. POST /projects/:id/merge_requests

Parameters:

projectId - the ID of a project, required

sourceBranch - the source branch, required

targetBranch - the target branch, required

title - the title for the merge request, required

description - the description of the merge request

assigneeId - the Assignee user ID, optional

Returns:

the created MergeRequest instance

Throws:

GitLabApiException - if any exception occurs

updateMergeRequest

public MergeRequest updateMergeRequest(Integer projectId,
                                       Integer mergeRequestIid,
                                       String targetBranch,
                                       String title,
                                       Integer assigneeId,
                                       String description,
                                       Constants.StateEvent stateEvent,
                                       String labels,
                                       Integer milestoneId)
                                throws GitLabApiException

Updates an existing merge request. You can change branches, title, or even close the MR.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

PUT /projects/:id/merge_requests/:merge_request_iid

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request to update

targetBranch - the target branch, optional

title - the title for the merge request

assigneeId - the Assignee user ID, optional

description - the description of the merge request, optional

stateEvent - new state for the merge request, optional

labels - comma separated list of labels, optional

milestoneId - the ID of a milestone, optional

Returns:

the updated merge request

Throws:

GitLabApiException - if any exception occurs

updateMergeRequest

@Deprecated
public MergeRequest updateMergeRequest(Integer projectId,
                                       Integer mergeRequestIid,
                                       String sourceBranch,
                                       String targetBranch,
                                       String title,
                                       String description,
                                       Integer assigneeId)
                                throws GitLabApiException

Deprecated. as of release 4.4.3

Updates an existing merge request. You can change branches, title, or even close the MR.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

PUT /projects/:id/merge_requests/:merge_request_iid

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request to update

sourceBranch - the source branch

targetBranch - the target branch

title - the title for the merge request

description - the description of the merge request

assigneeId - the Assignee user ID, optional

Returns:

the updated merge request

Throws:

GitLabApiException - if any exception occurs

deleteMergeRequest

public void deleteMergeRequest(Integer projectId,
                               Integer mergeRequestIid)
                        throws GitLabApiException

Only for admins and project owners. Soft deletes the specified merge.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

DELETE /projects/:id/merge_requests/:merge_request_iid

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request

Throws:

GitLabApiException - if any exception occurs

acceptMergeRequest

public MergeRequest acceptMergeRequest(Integer projectId,
                                       Integer mergeRequestIid)
                                throws GitLabApiException

Merge changes to the merge request. If the MR has any conflicts and can not be merged, you'll get a 405 and the error message 'Branch cannot be merged'. If merge request is already merged or closed, you'll get a 406 and the error message 'Method Not Allowed'. If the sha parameter is passed and does not match the HEAD of the source, you'll get a 409 and the error message 'SHA does not match HEAD of source branch'. If you don't have permissions to accept this merge request, you'll get a 401.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

PUT /projects/:id/merge_requests/:merge_request_iid/merge

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request

Returns:

the merged merge request

Throws:

GitLabApiException - if any exception occurs

acceptMergeRequest

public MergeRequest acceptMergeRequest(Integer projectId,
                                       Integer mergeRequestIid,
                                       String mergeCommitMessage,
                                       Boolean shouldRemoveSourceBranch,
                                       Boolean mergeWhenPipelineSucceeds)
                                throws GitLabApiException

Merge changes to the merge request. If the MR has any conflicts and can not be merged, you'll get a 405 and the error message 'Branch cannot be merged'. If merge request is already merged or closed, you'll get a 406 and the error message 'Method Not Allowed'. If the sha parameter is passed and does not match the HEAD of the source, you'll get a 409 and the error message 'SHA does not match HEAD of source branch'. If you don't have permissions to accept this merge request, you'll get a 401.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request. Additionally, mergeWhenPipelineSucceeds sets the merge_when_build_succeeds flag for GitLab API V3.

PUT /projects/:id/merge_requests/:merge_request_iid/merge

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request

mergeCommitMessage - , custom merge commit message, optional

shouldRemoveSourceBranch - , if true removes the source branch, optional

mergeWhenPipelineSucceeds - , if true the MR is merged when the pipeline, optional

Returns:

the merged merge request

Throws:

GitLabApiException - if any exception occurs

acceptMergeRequest

public MergeRequest acceptMergeRequest(Integer projectId,
                                       Integer mergeRequestIid,
                                       String mergeCommitMessage,
                                       Boolean shouldRemoveSourceBranch,
                                       Boolean mergeWhenPipelineSucceeds,
                                       String sha)
                                throws GitLabApiException

Merge changes to the merge request. If the MR has any conflicts and can not be merged, you'll get a 405 and the error message 'Branch cannot be merged'. If merge request is already merged or closed, you'll get a 406 and the error message 'Method Not Allowed'. If the sha parameter is passed and does not match the HEAD of the source, you'll get a 409 and the error message 'SHA does not match HEAD of source branch'. If you don't have permissions to accept this merge request, you'll get a 401.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request. Additionally, mergeWhenPipelineSucceeds sets the merge_when_build_succeeds flag for GitLab API V3.

PUT /projects/:id/merge_requests/:merge_request_iid/merge

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request

mergeCommitMessage - , custom merge commit message, optional

shouldRemoveSourceBranch - , if true removes the source branch, optional

mergeWhenPipelineSucceeds - , if true the MR is merged when the pipeline, optional

sha - if present, then this SHA must match the HEAD of the source branch, otherwise the merge will fail, optional

Returns:

the merged merge request

Throws:

GitLabApiException - if any exception occurs

cancelMergeRequest

public MergeRequest cancelMergeRequest(Integer projectId,
                                       Integer mergeRequestIid)
                                throws GitLabApiException

Cancel merge when pipeline succeeds. If you don't have permissions to accept this merge request, you'll get a 401. If the merge request is already merged or closed, you get 405 and error message 'Method Not Allowed'. In case the merge request is not set to be merged when the pipeline succeeds, you'll also get a 406 error.

NOTE: GitLab API V4 uses IID (internal ID), V3 uses ID to identify the merge request.

PUT /projects/:id/merge_requests/:merge_request_iid/cancel_merge_when_pipeline_succeeds

Parameters:

projectId - the ID of a project

mergeRequestIid - the internal ID of the merge request

Returns:

the updated merge request

Throws:

GitLabApiException - if any exception occurs

getMergeRequestApprovals

public MergeRequest getMergeRequestApprovals(Integer projectId,
                                             Integer mergeRequestIid)
                                      throws GitLabApiException

Get the merge request with approval information. Note: This API endpoint is only available on 8.9 EE and above. GET /projects/:id/merge_requests/:merge_request_iid/approvals

Parameters:

projectId - the project ID of the merge request

mergeRequestIid - the internal ID of the merge request

Returns:

a MergeRequest instance with approval information included

Throws:

GitLabApiException - if any exception occurs

approveMergeRequest

public MergeRequest approveMergeRequest(Integer projectId,
                                        Integer mergeRequestIid,
                                        String sha)
                                 throws GitLabApiException

Approve a merge request. Note: This API endpoint is only available on 8.9 EE and above. POST /projects/:id/merge_requests/:merge_request_iid/approve

Parameters:

projectId - the project ID of the merge request

mergeRequestIid - the internal ID of the merge request

sha - the HEAD of the merge request, optional

Returns:

a MergeRequest instance with approval information included

Throws:

GitLabApiException - if any exception occurs

unapproveMergeRequest

public MergeRequest unapproveMergeRequest(Integer projectId,
                                          Integer mergeRequestIid)
                                   throws GitLabApiException

Unapprove a merge request. Note: This API endpoint is only available on 8.9 EE and above. POST /projects/:id/merge_requests/:merge_request_iid/unapprove

Parameters:

projectId - the project ID of the merge request

mergeRequestIid - the internal ID of the merge request

Returns:

a MergeRequest instance with approval information included

Throws:

GitLabApiException - if any exception occurs