ForeignKey¶
- class oci.data_integration.models.ForeignKey(**kwargs)¶
Bases:
KeyThe foreign key object.
Attributes:
A constant which can be used with the model_type property of a Key.
Gets the attribute_refs of this ForeignKey.
Gets the delete_rule of this ForeignKey.
Gets the key of this ForeignKey.
[Required] Gets the model_type of this Key.
Gets the model_version of this ForeignKey.
Gets the name of this ForeignKey.
Gets the object_status of this ForeignKey.
Gets the parent_ref of this ForeignKey.
Gets the reference_unique_key of this ForeignKey.
Gets the update_rule of this ForeignKey.
Methods:
__init__(**kwargs)Initializes a new ForeignKey object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- MODEL_TYPE_FOREIGN_KEY = 'FOREIGN_KEY'¶
A constant which can be used with the model_type property of a Key. This constant has a value of “FOREIGN_KEY”
- __init__(**kwargs)¶
Initializes a new ForeignKey object with values from keyword arguments. The default value of the
model_typeattribute of this class isFOREIGN_KEYand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
model_type (str) – The value to assign to the model_type property of this ForeignKey. Allowed values for this property are: “FOREIGN_KEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
key (str) – The value to assign to the key property of this ForeignKey.
model_version (str) – The value to assign to the model_version property of this ForeignKey.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this ForeignKey.
name (str) – The value to assign to the name property of this ForeignKey.
attribute_refs (list[oci.data_integration.models.KeyAttribute]) – The value to assign to the attribute_refs property of this ForeignKey.
update_rule (int) – The value to assign to the update_rule property of this ForeignKey.
delete_rule (int) – The value to assign to the delete_rule property of this ForeignKey.
reference_unique_key (oci.data_integration.models.UniqueKey) – The value to assign to the reference_unique_key property of this ForeignKey.
object_status (int) – The value to assign to the object_status property of this ForeignKey.
- property attribute_refs¶
Gets the attribute_refs of this ForeignKey. An array of attribute references.
- Returns
The attribute_refs of this ForeignKey.
- Return type
- property delete_rule¶
Gets the delete_rule of this ForeignKey. The delete rule.
- Returns
The delete_rule of this ForeignKey.
- Return type
int
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property key¶
Gets the key of this ForeignKey. The object key.
- Returns
The key of this ForeignKey.
- Return type
str
- property model_type¶
[Required] Gets the model_type of this Key. The key type.
Allowed values for this property are: “FOREIGN_KEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The model_type of this Key.
- Return type
str
- property model_version¶
Gets the model_version of this ForeignKey. The object’s model version.
- Returns
The model_version of this ForeignKey.
- Return type
str
- property name¶
Gets the name of this ForeignKey. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
- Returns
The name of this ForeignKey.
- Return type
str
- property object_status¶
Gets the object_status of this ForeignKey. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- Returns
The object_status of this ForeignKey.
- Return type
int
- property parent_ref¶
Gets the parent_ref of this ForeignKey.
- Returns
The parent_ref of this ForeignKey.
- Return type
- property reference_unique_key¶
Gets the reference_unique_key of this ForeignKey.
- Returns
The reference_unique_key of this ForeignKey.
- Return type
- property update_rule¶
Gets the update_rule of this ForeignKey. The update rule.
- Returns
The update_rule of this ForeignKey.
- Return type
int