Package org.wso2.am.integration.clients.governance.api.dto

Class RulesetInputDTO

java.lang.Object

org.wso2.am.integration.clients.governance.api.dto.RulesetInputDTO

public class RulesetInputDTO
extends Object

Detailed information about a ruleset.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RulesetInputDTO.ArtifactTypeEnum	The type of artifact that the ruleset validates.
static enum	RulesetInputDTO.RuleCategoryEnum	Category the rules included in ruleset.
static enum	RulesetInputDTO.RuleTypeEnum	Context or area to which the ruleset applies.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_ARTIFACT_TYPE
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DOCUMENTATION_LINK
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_PROVIDER
static final String	SERIALIZED_NAME_RULE_CATEGORY
static final String	SERIALIZED_NAME_RULE_TYPE
static final String	SERIALIZED_NAME_RULESET_CONTENT

Constructor Summary

Constructors

Constructor	Description
RulesetInputDTO()

Method Summary

Modifier and Type	Method	Description
RulesetInputDTO	artifactType(RulesetInputDTO.ArtifactTypeEnum artifactType)
RulesetInputDTO	description(String description)
RulesetInputDTO	documentationLink(String documentationLink)
boolean	equals(Object o)
RulesetInputDTO.ArtifactTypeEnum	getArtifactType()	The type of artifact that the ruleset validates.
String	getDescription()	A brief description of the ruleset.
String	getDocumentationLink()	URL to the documentation related to the ruleset.
String	getName()	Name of the ruleset.
String	getProvider()	Entity or individual providing the ruleset.
RulesetInputDTO.RuleCategoryEnum	getRuleCategory()	Category the rules included in ruleset.
File	getRulesetContent()	The content of the ruleset file (YAML or JSON).
RulesetInputDTO.RuleTypeEnum	getRuleType()	Context or area to which the ruleset applies.
int	hashCode()
RulesetInputDTO	name(String name)
RulesetInputDTO	provider(String provider)
RulesetInputDTO	ruleCategory(RulesetInputDTO.RuleCategoryEnum ruleCategory)
RulesetInputDTO	rulesetContent(File rulesetContent)
RulesetInputDTO	ruleType(RulesetInputDTO.RuleTypeEnum ruleType)
void	setArtifactType(RulesetInputDTO.ArtifactTypeEnum artifactType)
void	setDescription(String description)
void	setDocumentationLink(String documentationLink)
void	setName(String name)
void	setProvider(String provider)
void	setRuleCategory(RulesetInputDTO.RuleCategoryEnum ruleCategory)
void	setRulesetContent(File rulesetContent)
void	setRuleType(RulesetInputDTO.RuleTypeEnum ruleType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_RULESET_CONTENT

public static final String SERIALIZED_NAME_RULESET_CONTENT

See Also:

• Constant Field Values

SERIALIZED_NAME_RULE_CATEGORY

public static final String SERIALIZED_NAME_RULE_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_RULE_TYPE

public static final String SERIALIZED_NAME_RULE_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_ARTIFACT_TYPE

public static final String SERIALIZED_NAME_ARTIFACT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_DOCUMENTATION_LINK

public static final String SERIALIZED_NAME_DOCUMENTATION_LINK

See Also:

• Constant Field Values

SERIALIZED_NAME_PROVIDER

public static final String SERIALIZED_NAME_PROVIDER

See Also:

• Constant Field Values

Constructor Details

RulesetInputDTO

public RulesetInputDTO()

Method Details

name

public RulesetInputDTO name(String name)

getName

public String getName()

Name of the ruleset.

Returns:

name

setName

public void setName(String name)

description

public RulesetInputDTO description(String description)

getDescription

@Nullable
public String getDescription()

A brief description of the ruleset.

Returns:

description

setDescription

public void setDescription(String description)

rulesetContent

public RulesetInputDTO rulesetContent(File rulesetContent)

getRulesetContent

public File getRulesetContent()

The content of the ruleset file (YAML or JSON).

Returns:

rulesetContent

setRulesetContent

public void setRulesetContent(File rulesetContent)

ruleCategory

public RulesetInputDTO ruleCategory(RulesetInputDTO.RuleCategoryEnum ruleCategory)

getRuleCategory

@Nullable
public RulesetInputDTO.RuleCategoryEnum getRuleCategory()

Category the rules included in ruleset.

Returns:

ruleCategory

setRuleCategory

public void setRuleCategory(RulesetInputDTO.RuleCategoryEnum ruleCategory)

ruleType

public RulesetInputDTO ruleType(RulesetInputDTO.RuleTypeEnum ruleType)

getRuleType

public RulesetInputDTO.RuleTypeEnum getRuleType()

Context or area to which the ruleset applies.

Returns:

ruleType

setRuleType

public void setRuleType(RulesetInputDTO.RuleTypeEnum ruleType)

artifactType

public RulesetInputDTO artifactType(RulesetInputDTO.ArtifactTypeEnum artifactType)

getArtifactType

public RulesetInputDTO.ArtifactTypeEnum getArtifactType()

The type of artifact that the ruleset validates.

Returns:

artifactType

setArtifactType

public void setArtifactType(RulesetInputDTO.ArtifactTypeEnum artifactType)

documentationLink

public RulesetInputDTO documentationLink(String documentationLink)

getDocumentationLink

@Nullable
public String getDocumentationLink()

URL to the documentation related to the ruleset.

Returns:

documentationLink

setDocumentationLink

public void setDocumentationLink(String documentationLink)

provider

public RulesetInputDTO provider(String provider)

getProvider

@Nullable
public String getProvider()

Entity or individual providing the ruleset.

Returns:

provider

setProvider

public void setProvider(String provider)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object