Package com.oracle.bmc.governancerulescontrolplane.model

Class GovernanceRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.governancerulescontrolplane.model.GovernanceRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220504")
public final class GovernanceRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Represents a rule in parent tenancy which governs resources in child tenancies.
Note: Objects should always be created or deserialized using the GovernanceRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the GovernanceRule.Builder, which maintain a set of all explicitly set fields called GovernanceRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GovernanceRule.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
GovernanceRule(String id, String compartmentId, String displayName, String description, GovernanceRuleType type, CreationOption creationOption, Template template, String relatedResourceId, Date timeCreated, Date timeUpdated, GovernanceRuleLifecycleState lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static GovernanceRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The Oracle ID (OCID) of the root compartment containing the governance rule.
CreationOption	getCreationOption()	The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	Description of the governance rule.
String	getDisplayName()	Display name of the governance rule.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	The Oracle ID (OCID) of the governance rule.
GovernanceRuleLifecycleState	getLifecycleState()	The current state of the governance rule.
String	getRelatedResourceId()	The Oracle ID (OCID) of the resource, which was used as a template to create this governance rule.
Map<String,Map<String,Object>>	getSystemTags()	System tags for this resource.
Template	getTemplate()
Date	getTimeCreated()	Date and time the governance rule was created.
Date	getTimeUpdated()	Date and time the governance rule was updated.
GovernanceRuleType	getType()	Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.
int	hashCode()
GovernanceRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceRule

@Deprecated
@ConstructorProperties({"id","compartmentId","displayName","description","type","creationOption","template","relatedResourceId","timeCreated","timeUpdated","lifecycleState","freeformTags","definedTags","systemTags"})
public GovernanceRule(String id,
                      String compartmentId,
                      String displayName,
                      String description,
                      GovernanceRuleType type,
                      CreationOption creationOption,
                      Template template,
                      String relatedResourceId,
                      Date timeCreated,
                      Date timeUpdated,
                      GovernanceRuleLifecycleState lifecycleState,
                      Map<String,String> freeformTags,
                      Map<String,Map<String,Object>> definedTags,
                      Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static GovernanceRule.Builder builder()

Create a new builder.

toBuilder

public GovernanceRule.Builder toBuilder()

getId

public String getId()

The Oracle ID (OCID) of the governance rule.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The Oracle ID (OCID) of the root compartment containing the governance rule.

Returns:

the value

getDisplayName

public String getDisplayName()

Display name of the governance rule.

Returns:

the value

getDescription

public String getDescription()

Description of the governance rule.

Returns:

the value

getType

public GovernanceRuleType getType()

Type of the governance rule, can be one of QUOTA, TAG, ALLOWED_REGIONS.

Example: QUOTA

Returns:

the value

getCreationOption

public CreationOption getCreationOption()

The type of option used to create the governance rule, could be one of TEMPLATE or CLONE.

Example: TEMPLATE

Returns:

the value

getTemplate

public Template getTemplate()

getRelatedResourceId

public String getRelatedResourceId()

The Oracle ID (OCID) of the resource, which was used as a template to create this governance rule.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Date and time the governance rule was created.

An RFC3339 formatted datetime string.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

Date and time the governance rule was updated.

An RFC3339 formatted datetime string.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getLifecycleState

public GovernanceRuleLifecycleState getLifecycleState()

The current state of the governance rule.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

System tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel