ReferentialRelation¶
- class oci.data_safe.models.ReferentialRelation(**kwargs)¶
Bases:
objectA referential relation is a resource corresponding to database columns. It’s a subresource of sensitive data model resource and is always associated with a sensitive data model.
Attributes:
A constant which can be used with the lifecycle_state property of a ReferentialRelation.
A constant which can be used with the lifecycle_state property of a ReferentialRelation.
A constant which can be used with the lifecycle_state property of a ReferentialRelation.
A constant which can be used with the lifecycle_state property of a ReferentialRelation.
A constant which can be used with the lifecycle_state property of a ReferentialRelation.
A constant which can be used with the relation_type property of a ReferentialRelation.
A constant which can be used with the relation_type property of a ReferentialRelation.
A constant which can be used with the relation_type property of a ReferentialRelation.
[Required] Gets the child of this ReferentialRelation.
Gets the is_sensitive of this ReferentialRelation.
[Required] Gets the key of this ReferentialRelation.
[Required] Gets the lifecycle_state of this ReferentialRelation.
[Required] Gets the parent of this ReferentialRelation.
[Required] Gets the relation_type of this ReferentialRelation.
[Required] Gets the sensitive_data_model_id of this ReferentialRelation.
Methods:
__init__(**kwargs)Initializes a new ReferentialRelation object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a ReferentialRelation. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ReferentialRelation. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ReferentialRelation. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a ReferentialRelation. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a ReferentialRelation. This constant has a value of “UPDATING”
- RELATION_TYPE_APP_DEFINED = 'APP_DEFINED'¶
A constant which can be used with the relation_type property of a ReferentialRelation. This constant has a value of “APP_DEFINED”
- RELATION_TYPE_DB_DEFINED = 'DB_DEFINED'¶
A constant which can be used with the relation_type property of a ReferentialRelation. This constant has a value of “DB_DEFINED”
- RELATION_TYPE_NONE = 'NONE'¶
A constant which can be used with the relation_type property of a ReferentialRelation. This constant has a value of “NONE”
- __init__(**kwargs)¶
Initializes a new ReferentialRelation 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 ReferentialRelation.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReferentialRelation. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sensitive_data_model_id (str) – The value to assign to the sensitive_data_model_id property of this ReferentialRelation.
relation_type (str) – The value to assign to the relation_type property of this ReferentialRelation. Allowed values for this property are: “NONE”, “APP_DEFINED”, “DB_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parent (oci.data_safe.models.ColumnsInfo) – The value to assign to the parent property of this ReferentialRelation.
child (oci.data_safe.models.ColumnsInfo) – The value to assign to the child property of this ReferentialRelation.
is_sensitive (bool) – The value to assign to the is_sensitive property of this ReferentialRelation.
- property child¶
[Required] Gets the child of this ReferentialRelation.
- Returns
The child of this ReferentialRelation.
- Return type
- property is_sensitive¶
Gets the is_sensitive of this ReferentialRelation. Determines if the columns present in the referential relation is present in the sensitive data model
- Returns
The is_sensitive of this ReferentialRelation.
- Return type
bool
- property key¶
[Required] Gets the key of this ReferentialRelation. The unique key that identifies the referential relation. It’s numeric and unique within a sensitive data model.
- Returns
The key of this ReferentialRelation.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ReferentialRelation. The current state of the referential relation.
Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this ReferentialRelation.
- Return type
str
- property parent¶
[Required] Gets the parent of this ReferentialRelation.
- Returns
The parent of this ReferentialRelation.
- Return type
- property relation_type¶
[Required] Gets the relation_type of this ReferentialRelation. The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
Allowed values for this property are: “NONE”, “APP_DEFINED”, “DB_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The relation_type of this ReferentialRelation.
- Return type
str
- property sensitive_data_model_id¶
[Required] Gets the sensitive_data_model_id of this ReferentialRelation. The OCID of the sensitive data model that contains the sensitive column.
- Returns
The sensitive_data_model_id of this ReferentialRelation.
- Return type
str