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.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder

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
MergeRequestApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
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.
MergeRequest	getMergeRequest(Integer projectId, Integer mergeRequestId) Get information about a single merge request.
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.
MergeRequest	updateMergeRequest(Integer projectId, Integer mergeRequestId, String sourceBranch, String targetBranch, String title, String description, Integer assigneeId) Updates an existing merge request.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, handle, isApiVersion, post, post, post, put, put, 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

getMergeRequest

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

Get information about a single merge request. GET /projects/:id/merge_request/:merge_request_id

Parameters:

projectId - the project ID of the merge request

mergeRequestId - the ID of the merge request

Returns:

the specified MergeRequest instance

Throws:

GitLabApiException - if any exception occurs

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 mergeRequestId,
                                       String sourceBranch,
                                       String targetBranch,
                                       String title,
                                       String description,
                                       Integer assigneeId)
                                throws GitLabApiException

Updates an existing merge request. You can change branches, title, or even close the MR. PUT /projects/:id/merge_request/:merge_request_id

Parameters:

projectId - the ID of a project

mergeRequestId - the 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