Module org.kohsuke.github.api

Package org.kohsuke.github

Class GHRepositoryRule

java.lang.Object

org.kohsuke.github.GHRepositoryRule

public class GHRepositoryRule
extends Object

Represents a repository rule.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GHRepositoryRule.AlertsThreshold	Alerts threshold parameter.
static class	GHRepositoryRule.BooleanParameter	Boolean parameter for a ruleset.
static class	GHRepositoryRule.CodeScanningTool	Code scanning tool parameter.
static class	GHRepositoryRule.IntegerParameter	Integer parameter for a ruleset.
static class	GHRepositoryRule.ListParameter<T>	List parameter for a ruleset.
static enum	GHRepositoryRule.Operator	Operator parameter.
static class	GHRepositoryRule.Parameter<T>	Basic parameter for a ruleset.
static interface	GHRepositoryRule.Parameters	Available parameters for a ruleset.
static enum	GHRepositoryRule.RulesetSourceType	The source of the ruleset type.
static enum	GHRepositoryRule.SecurityAlertsThreshold	Security alerts threshold parameter.
static class	GHRepositoryRule.StatusCheckConfiguration	Status check configuration parameter.
static class	GHRepositoryRule.StringParameter	String parameter for a ruleset.
static enum	GHRepositoryRule.Type	The type of the ruleset.
static class	GHRepositoryRule.WorkflowFileReference	Workflow file reference parameter.

Constructor Summary

Constructors

Constructor	Description
GHRepositoryRule()	Create default GHRepositoryRule instance

Method Summary

Modifier and Type	Method	Description
<T> Optional<T>	getParameter(GHRepositoryRule.Parameter<T> parameter)	Gets a parameter
long	getRulesetId()	Gets the ruleset id.
String	getRulesetSource()	Gets the ruleset source.
GHRepositoryRule.RulesetSourceType	getRulesetSourceType()	Gets the ruleset source type.
GHRepositoryRule.Type	getType()	Gets the type.

Methods inherited from class java.lang.Object

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

Constructor Details

GHRepositoryRule

public GHRepositoryRule()

Create default GHRepositoryRule instance

Method Details

getType

public GHRepositoryRule.Type getType()

Gets the type.

Returns:

the type

getRulesetSourceType

public GHRepositoryRule.RulesetSourceType getRulesetSourceType()

Gets the ruleset source type.

Returns:

the ruleset source type

getRulesetSource

public String getRulesetSource()

Gets the ruleset source.

Returns:

the ruleset source

getRulesetId

public long getRulesetId()

Gets the ruleset id.

Returns:

the ruleset id

getParameter

public <T> Optional<T> getParameter(GHRepositoryRule.Parameter<T> parameter)
                             throws IOException

Gets a parameter. (Parameters provides a list of available parameters.)

Type Parameters:

T - the type of the parameter

Parameters:

parameter - the parameter

Returns:

the parameters

Throws:

IOException - if an I/O error occurs