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

Class APIMGovernancePolicyDTO

java.lang.Object

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

public class APIMGovernancePolicyDTO
extends Object

Detailed information about a governance policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	APIMGovernancePolicyDTO.GovernableStatesEnum	The state at which an governance policy should be enforced.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZED_NAME_ACTIONS
static final String	SERIALIZED_NAME_CREATED_BY
static final String	SERIALIZED_NAME_CREATED_TIME
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_GOVERNABLE_STATES
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_LABELS
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_RULESETS
static final String	SERIALIZED_NAME_UPDATED_BY
static final String	SERIALIZED_NAME_UPDATED_TIME

Constructor Summary

Constructors

Constructor	Description
APIMGovernancePolicyDTO()

Method Summary

Modifier and Type	Method	Description
APIMGovernancePolicyDTO	actions(List<ActionDTO> actions)
APIMGovernancePolicyDTO	createdBy(String createdBy)
APIMGovernancePolicyDTO	createdTime(String createdTime)
APIMGovernancePolicyDTO	description(String description)
boolean	equals(Object o)
List<ActionDTO>	getActions()	List of actions taken when the governance policy is violated.
String	getCreatedBy()	Identifier of the user who created the governance policy.
String	getCreatedTime()	Timestamp when the governance policy was created.
String	getDescription()	A brief description of the governance policy.
List<APIMGovernancePolicyDTO.GovernableStatesEnum>	getGovernableStates()	List of states at which the governance policy should be enforced.
String	getId()	UUID of the governance policy.
List<String>	getLabels()	List of labels IDs associated with the governance policy.
String	getName()	Name of the governance policy.
List<String>	getRulesets()	List of rulesets associated with the governance policy.
String	getUpdatedBy()	Identifier of the user who last updated the governance policy.
String	getUpdatedTime()	Timestamp when the governance policy was last updated.
APIMGovernancePolicyDTO	governableStates(List<APIMGovernancePolicyDTO.GovernableStatesEnum> governableStates)
int	hashCode()
APIMGovernancePolicyDTO	id(String id)
APIMGovernancePolicyDTO	labels(List<String> labels)
APIMGovernancePolicyDTO	name(String name)
APIMGovernancePolicyDTO	rulesets(List<String> rulesets)
void	setActions(List<ActionDTO> actions)
void	setCreatedBy(String createdBy)
void	setCreatedTime(String createdTime)
void	setDescription(String description)
void	setGovernableStates(List<APIMGovernancePolicyDTO.GovernableStatesEnum> governableStates)
void	setId(String id)
void	setLabels(List<String> labels)
void	setName(String name)
void	setRulesets(List<String> rulesets)
void	setUpdatedBy(String updatedBy)
void	setUpdatedTime(String updatedTime)
String	toString()
APIMGovernancePolicyDTO	updatedBy(String updatedBy)
APIMGovernancePolicyDTO	updatedTime(String updatedTime)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

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_GOVERNABLE_STATES

public static final String SERIALIZED_NAME_GOVERNABLE_STATES

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIONS

public static final String SERIALIZED_NAME_ACTIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_RULESETS

public static final String SERIALIZED_NAME_RULESETS

See Also:

• Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_BY

public static final String SERIALIZED_NAME_CREATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_TIME

public static final String SERIALIZED_NAME_CREATED_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_BY

public static final String SERIALIZED_NAME_UPDATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_TIME

public static final String SERIALIZED_NAME_UPDATED_TIME

See Also:

• Constant Field Values

Constructor Details

APIMGovernancePolicyDTO

public APIMGovernancePolicyDTO()

Method Details

id

public APIMGovernancePolicyDTO id(String id)

getId

@Nullable
public String getId()

UUID of the governance policy.

Returns:

id

setId

public void setId(String id)

name

public APIMGovernancePolicyDTO name(String name)

getName

public String getName()

Name of the governance policy.

Returns:

name

setName

public void setName(String name)

description

public APIMGovernancePolicyDTO description(String description)

getDescription

@Nullable
public String getDescription()

A brief description of the governance policy.

Returns:

description

setDescription

public void setDescription(String description)

governableStates

public APIMGovernancePolicyDTO governableStates(List<APIMGovernancePolicyDTO.GovernableStatesEnum> governableStates)

getGovernableStates

public List<APIMGovernancePolicyDTO.GovernableStatesEnum> getGovernableStates()

List of states at which the governance policy should be enforced.

Returns:

governableStates

setGovernableStates

public void setGovernableStates(List<APIMGovernancePolicyDTO.GovernableStatesEnum> governableStates)

actions

public APIMGovernancePolicyDTO actions(List<ActionDTO> actions)

getActions

public List<ActionDTO> getActions()

List of actions taken when the governance policy is violated. An action is defined by the state and rule severity. If an action is not specified to each state and rule severity, the default action is `NOTIFY`.

Returns:

actions

setActions

public void setActions(List<ActionDTO> actions)

rulesets

public APIMGovernancePolicyDTO rulesets(List<String> rulesets)

getRulesets

public List<String> getRulesets()

List of rulesets associated with the governance policy.

Returns:

rulesets

setRulesets

public void setRulesets(List<String> rulesets)

labels

public APIMGovernancePolicyDTO labels(List<String> labels)

getLabels

public List<String> getLabels()

List of labels IDs associated with the governance policy.

Returns:

labels

setLabels

public void setLabels(List<String> labels)

createdBy

public APIMGovernancePolicyDTO createdBy(String createdBy)

getCreatedBy

@Nullable
public String getCreatedBy()

Identifier of the user who created the governance policy.

Returns:

createdBy

setCreatedBy

public void setCreatedBy(String createdBy)

createdTime

public APIMGovernancePolicyDTO createdTime(String createdTime)

getCreatedTime

@Nullable
public String getCreatedTime()

Timestamp when the governance policy was created.

Returns:

createdTime

setCreatedTime

public void setCreatedTime(String createdTime)

updatedBy

public APIMGovernancePolicyDTO updatedBy(String updatedBy)

getUpdatedBy

@Nullable
public String getUpdatedBy()

Identifier of the user who last updated the governance policy.

Returns:

updatedBy

setUpdatedBy

public void setUpdatedBy(String updatedBy)

updatedTime

public APIMGovernancePolicyDTO updatedTime(String updatedTime)

getUpdatedTime

@Nullable
public String getUpdatedTime()

Timestamp when the governance policy was last updated.

Returns:

updatedTime

setUpdatedTime

public void setUpdatedTime(String updatedTime)

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