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.EnforceAdmins	The type EnforceAdmins.
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()	Deprecated.
void	enabledSignedCommits()	Deprecated.
GHBranchProtection.EnforceAdmins	getEnforceAdmins()	Gets enforce admins.
GHBranchProtection.RequiredReviews	getRequiredReviews()	Gets required reviews.
boolean	getRequiredSignatures()	Deprecated.
GHBranchProtection.RequiredStatusChecks	getRequiredStatusChecks()	Gets required status checks.
GHBranchProtection.Restrictions	getRestrictions()	Gets restrictions.
String	getUrl()	Gets url.

Methods inherited from class java.lang.Object

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

Constructor Detail

GHBranchProtection

public GHBranchProtection()

Method Detail

enabledSignedCommits

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

Deprecated.

Enabled signed commits.

Throws:

IOException - the io exception

disableSignedCommits

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

Deprecated.

Disable signed commits.

Throws:

IOException - the io exception

getEnforceAdmins

public GHBranchProtection.EnforceAdmins getEnforceAdmins()

Gets enforce admins.

Returns:

the enforce admins

getRequiredReviews

public GHBranchProtection.RequiredReviews getRequiredReviews()

Gets required reviews.

Returns:

the required reviews

getRequiredSignatures

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

Deprecated.

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