Package org.gitlab4j.api

Class ProtectedBranchesApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ProtectedBranchesApi

All Implemented Interfaces:

Constants

public class ProtectedBranchesApi
extends AbstractApi

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

Method Summary

Modifier and Type	Method	Description
List<ProtectedBranch>	getProtectedBranches(Integer projectId)	Gets a list of protected branches from a project.
ProtectedBranch	protectBranch(Integer projectId, String branchName)	Protects a single repository branch or several project repository branches using a wildcard protected branch.
ProtectedBranch	protectBranch(Integer projectId, String branchName, AccessLevel pushAccessLevel, AccessLevel mergeAccessLevel)	Protects a single repository branch or several project repository branches using a wildcard protected branch.
void	unprotectBranch(Integer projectId, String branchName)	Unprotects the given protected branch or wildcard protected branch.

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, post, put, put, putWithFormData, upload, upload, urlEncode, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtectedBranchesApi

public ProtectedBranchesApi(GitLabApi gitLabApi)

Method Detail

getProtectedBranches

public List<ProtectedBranch> getProtectedBranches(Integer projectId)
                                           throws GitLabApiException

Gets a list of protected branches from a project. GET /projects/:id/protected_branches

Parameters:

projectId - the ID of the project to protect

Returns:

the list of protected branches for the project

Throws:

GitLabApiException - if any exception occurs

unprotectBranch

public void unprotectBranch(Integer projectId,
                            String branchName)
                     throws GitLabApiException

Unprotects the given protected branch or wildcard protected branch. DELETE /projects/:id/protected_branches/:name

Parameters:

projectId - the ID of the project to un-protect

branchName - the name of the branch to un-protect

Throws:

GitLabApiException - if any exception occurs

protectBranch

public ProtectedBranch protectBranch(Integer projectId,
                                     String branchName)
                              throws GitLabApiException

Protects a single repository branch or several project repository branches using a wildcard protected branch. POST /projects/:id/protected_branches

Parameters:

projectId - the ID of the project to protect

branchName - the name of the branch to protect

Returns:

the branch info for the protected branch

Throws:

GitLabApiException - if any exception occurs

protectBranch

public ProtectedBranch protectBranch(Integer projectId,
                                     String branchName,
                                     AccessLevel pushAccessLevel,
                                     AccessLevel mergeAccessLevel)
                              throws GitLabApiException

Protects a single repository branch or several project repository branches using a wildcard protected branch. POST /projects/:id/protected_branches

Parameters:

projectId - the ID of the project to protect

branchName - the name of the branch to protect

pushAccessLevel - Access levels allowed to push (defaults: 40, master access level)

mergeAccessLevel - Access levels allowed to merge (defaults: 40, master access level)

Returns:

the branch info for the protected branch

Throws:

GitLabApiException - if any exception occurs