Package org.kohsuke.github

Class GHBranchProtection

java.lang.Object

org.kohsuke.github.GHBranchProtection

public class GHBranchProtection
extends Object

The type GHBranchProtection.

See Also:

• GitHub Branch Protection

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GHBranchProtection.AllowDeletions	The type AllowDeletions.
static class	GHBranchProtection.AllowForcePushes	The type AllowForcePushes.
static class	GHBranchProtection.AllowForkSyncing	The type AllowForkSyncing.
static class	GHBranchProtection.BlockCreations	The type BlockCreations.
static class	GHBranchProtection.EnforceAdmins	The type EnforceAdmins.
static class	GHBranchProtection.LockBranch	The type LockBranch.
static class	GHBranchProtection.RequiredConversationResolution	The type RequiredConversationResolution.
static class	GHBranchProtection.RequiredLinearHistory	The type RequiredLinearHistory.
static class	GHBranchProtection.RequiredReviews	The type RequiredReviews.
static class	GHBranchProtection.RequiredStatusChecks	The type RequiredStatusChecks.
static class	GHBranchProtection.Restrictions	The type Restrictions.

Constructor Summary

Constructors

Constructor	Description
GHBranchProtection()

Method Summary

Modifier and Type	Method	Description
void	disableSignedCommits()	Disable signed commits.
void	enabledSignedCommits()	Enabled signed commits.
GHBranchProtection.AllowDeletions	getAllowDeletions()	Gets allow deletions.
GHBranchProtection.AllowForcePushes	getAllowForcePushes()	Gets allow force pushes.
GHBranchProtection.AllowForkSyncing	getAllowForkSyncing()	Gets allow fork syncing.
GHBranchProtection.BlockCreations	getBlockCreations()	Gets block creations.
GHBranchProtection.EnforceAdmins	getEnforceAdmins()	Gets enforce admins.
GHBranchProtection.LockBranch	getLockBranch()	Gets lock branch.
GHBranchProtection.RequiredConversationResolution	getRequiredConversationResolution()	Gets required conversation resolution.
GHBranchProtection.RequiredLinearHistory	getRequiredLinearHistory()	Gets required linear history.
GHBranchProtection.RequiredReviews	getRequiredReviews()	Gets required reviews.
boolean	getRequiredSignatures()	Gets required signatures.
GHBranchProtection.RequiredStatusChecks	getRequiredStatusChecks()	Gets required status checks.
GHBranchProtection.Restrictions	getRestrictions()	Gets restrictions.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
String	getUrl()	Gets url.

Methods inherited from class java.lang.Object

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

Constructor Details

GHBranchProtection

public GHBranchProtection()

Method Details

enabledSignedCommits

@Preview(ZZZAX)
public void enabledSignedCommits()
                          throws IOException

Enabled signed commits.

Throws:

IOException - the io exception

disableSignedCommits

@Preview(ZZZAX)
public void disableSignedCommits()
                          throws IOException

Disable signed commits.

Throws:

IOException - the io exception

getAllowDeletions

public GHBranchProtection.AllowDeletions getAllowDeletions()

Gets allow deletions.

Returns:

the enforce admins

getAllowForcePushes

public GHBranchProtection.AllowForcePushes getAllowForcePushes()

Gets allow force pushes.

Returns:

the enforce admins

getAllowForkSyncing

public GHBranchProtection.AllowForkSyncing getAllowForkSyncing()

Gets allow fork syncing.

Returns:

the enforce admins

getBlockCreations

public GHBranchProtection.BlockCreations getBlockCreations()

Gets block creations.

Returns:

the enforce admins

getEnforceAdmins

public GHBranchProtection.EnforceAdmins getEnforceAdmins()

Gets enforce admins.

Returns:

the enforce admins

getLockBranch

public GHBranchProtection.LockBranch getLockBranch()

Gets lock branch.

Returns:

the enforce admins

getRequiredConversationResolution

public GHBranchProtection.RequiredConversationResolution getRequiredConversationResolution()

Gets required conversation resolution.

Returns:

the enforce admins

getRequiredLinearHistory

public GHBranchProtection.RequiredLinearHistory getRequiredLinearHistory()

Gets required linear history.

Returns:

the enforce admins

getRequiredReviews

public GHBranchProtection.RequiredReviews getRequiredReviews()

Gets required reviews.

Returns:

the required reviews

getRequiredSignatures

@Preview(ZZZAX)
public boolean getRequiredSignatures()
                              throws IOException

Gets required signatures.

Returns:

the required signatures

Throws:

IOException - the io exception

getRequiredStatusChecks

public GHBranchProtection.RequiredStatusChecks getRequiredStatusChecks()

Gets required status checks.

Returns:

the required status checks

getRestrictions

public GHBranchProtection.Restrictions getRestrictions()

Gets restrictions.

Returns:

the restrictions

getUrl

public String getUrl()

Gets url.

Returns:

the url

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance