Package com.oracle.bmc.datacatalog.model

Class RuleSummary

java.lang.Object

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

com.oracle.bmc.datacatalog.model.RuleSummary

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

A list of rule resources.

One or more rules can be defined for a data entity. Each rule can be defined on one or more attributes of the data entity.
Note: Objects should always be created or deserialized using the RuleSummary.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 RuleSummary.Builder, which maintain a set of all explicitly set fields called RuleSummary.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	RuleSummary.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

RuleSummary(String key, String displayName, String description, RuleType ruleType, String externalKey, List<RuleAttribute> attributes, String referencedFolderKey, String referencedFolderName, String referencedEntityKey, String referencedEntityName, String referencedRuleKey, String referencedRuleName, List<RuleAttribute> referencedAttributes, RuleOriginType originType, String uri, Date timeCreated, LifecycleState lifecycleState)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static RuleSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<RuleAttribute>	getAttributes()	Attributes associated with a rule.
String	getDescription()	Detailed description of a rule.
String	getDisplayName()	A user-friendly display name.
String	getExternalKey()	External URI that can be used to reference the object.
String	getKey()	Immutable unique key of a rule.
LifecycleState	getLifecycleState()	State of the rule.
RuleOriginType	getOriginType()	Origin type of the rule.
List<RuleAttribute>	getReferencedAttributes()	Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY.
String	getReferencedEntityKey()	Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
String	getReferencedEntityName()	Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
String	getReferencedFolderKey()	Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.
String	getReferencedFolderName()	Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.
String	getReferencedRuleKey()	Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
String	getReferencedRuleName()	Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
RuleType	getRuleType()	Type of a rule.
Date	getTimeCreated()	The date and time the rule was created, in the format defined by RFC3339.
String	getUri()	URI to the rule instance in the API.
int	hashCode()
RuleSummary.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

RuleSummary

@Deprecated
@ConstructorProperties({"key","displayName","description","ruleType","externalKey","attributes","referencedFolderKey","referencedFolderName","referencedEntityKey","referencedEntityName","referencedRuleKey","referencedRuleName","referencedAttributes","originType","uri","timeCreated","lifecycleState"})
public RuleSummary(String key,
                   String displayName,
                   String description,
                   RuleType ruleType,
                   String externalKey,
                   List<RuleAttribute> attributes,
                   String referencedFolderKey,
                   String referencedFolderName,
                   String referencedEntityKey,
                   String referencedEntityName,
                   String referencedRuleKey,
                   String referencedRuleName,
                   List<RuleAttribute> referencedAttributes,
                   RuleOriginType originType,
                   String uri,
                   Date timeCreated,
                   LifecycleState lifecycleState)

Deprecated.

Method Detail

builder

public static RuleSummary.Builder builder()

Create a new builder.

toBuilder

public RuleSummary.Builder toBuilder()

getKey

public String getKey()

Immutable unique key of a rule.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

Detailed description of a rule.

Returns:

the value

getRuleType

public RuleType getRuleType()

Type of a rule.

Returns:

the value

getExternalKey

public String getExternalKey()

External URI that can be used to reference the object.

Format will differ based on the type of object.

Returns:

the value

getAttributes

public List<RuleAttribute> getAttributes()

Attributes associated with a rule.

A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.

Returns:

the value

getReferencedFolderKey

public String getReferencedFolderKey()

Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Returns:

the value

getReferencedFolderName

public String getReferencedFolderName()

Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Returns:

the value

getReferencedEntityKey

public String getReferencedEntityKey()

Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Returns:

the value

getReferencedEntityName

public String getReferencedEntityName()

Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Returns:

the value

getReferencedRuleKey

public String getReferencedRuleKey()

Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Returns:

the value

getReferencedRuleName

public String getReferencedRuleName()

Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Returns:

the value

getReferencedAttributes

public List<RuleAttribute> getReferencedAttributes()

Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY.

A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).

Returns:

the value

getOriginType

public RuleOriginType getOriginType()

Origin type of the rule.

Returns:

the value

getUri

public String getUri()

URI to the rule instance in the API.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the rule was created, in the format defined by RFC3339.

Example: 2019-03-25T21:10:29.600Z

Returns:

the value

getLifecycleState

public LifecycleState getLifecycleState()

State of the rule.

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