RuleSummary

class oci.data_catalog.models.RuleSummary(**kwargs)

Bases: object

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.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_MOVING

A constant which can be used with the lifecycle_state property of a RuleSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a RuleSummary.

ORIGIN_TYPE_PROFILING

A constant which can be used with the origin_type property of a RuleSummary.

ORIGIN_TYPE_SOURCE

A constant which can be used with the origin_type property of a RuleSummary.

ORIGIN_TYPE_USER

A constant which can be used with the origin_type property of a RuleSummary.

RULE_TYPE_FOREIGNKEY

A constant which can be used with the rule_type property of a RuleSummary.

RULE_TYPE_PRIMARYKEY

A constant which can be used with the rule_type property of a RuleSummary.

RULE_TYPE_UNIQUEKEY

A constant which can be used with the rule_type property of a RuleSummary.

attributes

Gets the attributes of this RuleSummary.

description

Gets the description of this RuleSummary.

display_name

Gets the display_name of this RuleSummary.

external_key

Gets the external_key of this RuleSummary.

key

[Required] Gets the key of this RuleSummary.

lifecycle_state

Gets the lifecycle_state of this RuleSummary.

origin_type

Gets the origin_type of this RuleSummary.

referenced_attributes

Gets the referenced_attributes of this RuleSummary.

referenced_entity_key

Gets the referenced_entity_key of this RuleSummary.

referenced_entity_name

Gets the referenced_entity_name of this RuleSummary.

referenced_folder_key

Gets the referenced_folder_key of this RuleSummary.

referenced_folder_name

Gets the referenced_folder_name of this RuleSummary.

referenced_rule_key

Gets the referenced_rule_key of this RuleSummary.

referenced_rule_name

Gets the referenced_rule_name of this RuleSummary.

rule_type

Gets the rule_type of this RuleSummary.

time_created

Gets the time_created of this RuleSummary.

uri

Gets the uri of this RuleSummary.

Methods:

__init__(**kwargs)

Initializes a new RuleSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a RuleSummary. This constant has a value of “UPDATING”

ORIGIN_TYPE_PROFILING = 'PROFILING'

A constant which can be used with the origin_type property of a RuleSummary. This constant has a value of “PROFILING”

ORIGIN_TYPE_SOURCE = 'SOURCE'

A constant which can be used with the origin_type property of a RuleSummary. This constant has a value of “SOURCE”

ORIGIN_TYPE_USER = 'USER'

A constant which can be used with the origin_type property of a RuleSummary. This constant has a value of “USER”

RULE_TYPE_FOREIGNKEY = 'FOREIGNKEY'

A constant which can be used with the rule_type property of a RuleSummary. This constant has a value of “FOREIGNKEY”

RULE_TYPE_PRIMARYKEY = 'PRIMARYKEY'

A constant which can be used with the rule_type property of a RuleSummary. This constant has a value of “PRIMARYKEY”

RULE_TYPE_UNIQUEKEY = 'UNIQUEKEY'

A constant which can be used with the rule_type property of a RuleSummary. This constant has a value of “UNIQUEKEY”

__init__(**kwargs)

Initializes a new RuleSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • key (str) – The value to assign to the key property of this RuleSummary.

  • display_name (str) – The value to assign to the display_name property of this RuleSummary.

  • description (str) – The value to assign to the description property of this RuleSummary.

  • rule_type (str) – The value to assign to the rule_type property of this RuleSummary. Allowed values for this property are: “PRIMARYKEY”, “FOREIGNKEY”, “UNIQUEKEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • external_key (str) – The value to assign to the external_key property of this RuleSummary.

  • attributes (list[oci.data_catalog.models.RuleAttribute]) – The value to assign to the attributes property of this RuleSummary.

  • referenced_folder_key (str) – The value to assign to the referenced_folder_key property of this RuleSummary.

  • referenced_folder_name (str) – The value to assign to the referenced_folder_name property of this RuleSummary.

  • referenced_entity_key (str) – The value to assign to the referenced_entity_key property of this RuleSummary.

  • referenced_entity_name (str) – The value to assign to the referenced_entity_name property of this RuleSummary.

  • referenced_rule_key (str) – The value to assign to the referenced_rule_key property of this RuleSummary.

  • referenced_rule_name (str) – The value to assign to the referenced_rule_name property of this RuleSummary.

  • referenced_attributes (list[oci.data_catalog.models.RuleAttribute]) – The value to assign to the referenced_attributes property of this RuleSummary.

  • origin_type (str) – The value to assign to the origin_type property of this RuleSummary. Allowed values for this property are: “SOURCE”, “USER”, “PROFILING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • uri (str) – The value to assign to the uri property of this RuleSummary.

  • time_created (datetime) – The value to assign to the time_created property of this RuleSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RuleSummary. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property attributes

Gets the attributes of this RuleSummary. 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 attributes of this RuleSummary.

Return type

list[oci.data_catalog.models.RuleAttribute]

property description

Gets the description of this RuleSummary. Detailed description of a rule.

Returns

The description of this RuleSummary.

Return type

str

property display_name

Gets the display_name of this RuleSummary. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this RuleSummary.

Return type

str

property external_key

Gets the external_key of this RuleSummary. External URI that can be used to reference the object. Format will differ based on the type of object.

Returns

The external_key of this RuleSummary.

Return type

str

property key

[Required] Gets the key of this RuleSummary. Immutable unique key of a rule.

Returns

The key of this RuleSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this RuleSummary. State of the rule.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this RuleSummary.

Return type

str

property origin_type

Gets the origin_type of this RuleSummary. Origin type of the rule.

Allowed values for this property are: “SOURCE”, “USER”, “PROFILING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The origin_type of this RuleSummary.

Return type

str

property referenced_attributes

Gets the referenced_attributes of this RuleSummary. 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 referenced_attributes of this RuleSummary.

Return type

list[oci.data_catalog.models.RuleAttribute]

property referenced_entity_key

Gets the referenced_entity_key of this RuleSummary. Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Returns

The referenced_entity_key of this RuleSummary.

Return type

str

property referenced_entity_name

Gets the referenced_entity_name of this RuleSummary. Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.

Returns

The referenced_entity_name of this RuleSummary.

Return type

str

property referenced_folder_key

Gets the referenced_folder_key of this RuleSummary. Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Returns

The referenced_folder_key of this RuleSummary.

Return type

str

property referenced_folder_name

Gets the referenced_folder_name of this RuleSummary. Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.

Returns

The referenced_folder_name of this RuleSummary.

Return type

str

property referenced_rule_key

Gets the referenced_rule_key of this RuleSummary. Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Returns

The referenced_rule_key of this RuleSummary.

Return type

str

property referenced_rule_name

Gets the referenced_rule_name of this RuleSummary. Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.

Returns

The referenced_rule_name of this RuleSummary.

Return type

str

property rule_type

Gets the rule_type of this RuleSummary. Type of a rule.

Allowed values for this property are: “PRIMARYKEY”, “FOREIGNKEY”, “UNIQUEKEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The rule_type of this RuleSummary.

Return type

str

property time_created

Gets the time_created of this RuleSummary. The date and time the rule was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns

The time_created of this RuleSummary.

Return type

datetime

property uri

Gets the uri of this RuleSummary. URI to the rule instance in the API.

Returns

The uri of this RuleSummary.

Return type

str