Attribute

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

Bases: object

Details of an entity attribute. An attribute of a data entity describing an item of data, with a name and data type. Synonymous with ‘column’ in a database.

Attributes

ASSOCIATED_RULE_TYPES_FOREIGNKEY A constant which can be used with the associated_rule_types property of a Attribute.
ASSOCIATED_RULE_TYPES_PRIMARYKEY A constant which can be used with the associated_rule_types property of a Attribute.
ASSOCIATED_RULE_TYPES_UNIQUEKEY A constant which can be used with the associated_rule_types property of a Attribute.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a Attribute.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Attribute.
associated_rule_types Gets the associated_rule_types of this Attribute.
business_name Gets the business_name of this Attribute.
created_by_id Gets the created_by_id of this Attribute.
custom_property_members Gets the custom_property_members of this Attribute.
datatype_entity_key Gets the datatype_entity_key of this Attribute.
description Gets the description of this Attribute.
display_name Gets the display_name of this Attribute.
entity_key Gets the entity_key of this Attribute.
external_data_type Gets the external_data_type of this Attribute.
external_datatype_entity_key Gets the external_datatype_entity_key of this Attribute.
external_key Gets the external_key of this Attribute.
external_parent_attribute_key Gets the external_parent_attribute_key of this Attribute.
is_derived_attribute Gets the is_derived_attribute of this Attribute.
is_incremental_data Gets the is_incremental_data of this Attribute.
is_nullable Gets the is_nullable of this Attribute.
key [Required] Gets the key of this Attribute.
length Gets the length of this Attribute.
lifecycle_state Gets the lifecycle_state of this Attribute.
max_collection_count Gets the max_collection_count of this Attribute.
min_collection_count Gets the min_collection_count of this Attribute.
object_relationships Gets the object_relationships of this Attribute.
parent_attribute_key Gets the parent_attribute_key of this Attribute.
path Gets the path of this Attribute.
position Gets the position of this Attribute.
precision Gets the precision of this Attribute.
properties Gets the properties of this Attribute.
scale Gets the scale of this Attribute.
time_created Gets the time_created of this Attribute.
time_external Gets the time_external of this Attribute.
time_harvested Gets the time_harvested of this Attribute.
time_updated Gets the time_updated of this Attribute.
updated_by_id Gets the updated_by_id of this Attribute.
uri Gets the uri of this Attribute.

Methods

__init__(**kwargs) Initializes a new Attribute object with values from keyword arguments.
ASSOCIATED_RULE_TYPES_FOREIGNKEY = 'FOREIGNKEY'

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

ASSOCIATED_RULE_TYPES_PRIMARYKEY = 'PRIMARYKEY'

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

ASSOCIATED_RULE_TYPES_UNIQUEKEY = 'UNIQUEKEY'

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new Attribute 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 Attribute.
  • display_name (str) – The value to assign to the display_name property of this Attribute.
  • business_name (str) – The value to assign to the business_name property of this Attribute.
  • description (str) – The value to assign to the description property of this Attribute.
  • entity_key (str) – The value to assign to the entity_key property of this Attribute.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Attribute. 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’.
  • time_created (datetime) – The value to assign to the time_created property of this Attribute.
  • time_updated (datetime) – The value to assign to the time_updated property of this Attribute.
  • created_by_id (str) – The value to assign to the created_by_id property of this Attribute.
  • updated_by_id (str) – The value to assign to the updated_by_id property of this Attribute.
  • external_data_type (str) – The value to assign to the external_data_type property of this Attribute.
  • external_key (str) – The value to assign to the external_key property of this Attribute.
  • is_incremental_data (bool) – The value to assign to the is_incremental_data property of this Attribute.
  • is_nullable (bool) – The value to assign to the is_nullable property of this Attribute.
  • min_collection_count (int) – The value to assign to the min_collection_count property of this Attribute.
  • max_collection_count (int) – The value to assign to the max_collection_count property of this Attribute.
  • datatype_entity_key (str) – The value to assign to the datatype_entity_key property of this Attribute.
  • external_datatype_entity_key (str) – The value to assign to the external_datatype_entity_key property of this Attribute.
  • parent_attribute_key (str) – The value to assign to the parent_attribute_key property of this Attribute.
  • external_parent_attribute_key (str) – The value to assign to the external_parent_attribute_key property of this Attribute.
  • length (int) – The value to assign to the length property of this Attribute.
  • position (int) – The value to assign to the position property of this Attribute.
  • precision (int) – The value to assign to the precision property of this Attribute.
  • scale (int) – The value to assign to the scale property of this Attribute.
  • time_external (datetime) – The value to assign to the time_external property of this Attribute.
  • time_harvested (datetime) – The value to assign to the time_harvested property of this Attribute.
  • object_relationships (list[oci.data_catalog.models.ObjectRelationship]) – The value to assign to the object_relationships property of this Attribute.
  • is_derived_attribute (bool) – The value to assign to the is_derived_attribute property of this Attribute.
  • uri (str) – The value to assign to the uri property of this Attribute.
  • path (str) – The value to assign to the path property of this Attribute.
  • custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this Attribute.
  • properties (dict(str, dict(str, str))) – The value to assign to the properties property of this Attribute.
  • associated_rule_types (list[str]) – The value to assign to the associated_rule_types property of this Attribute. Allowed values for items in this list are: “PRIMARYKEY”, “FOREIGNKEY”, “UNIQUEKEY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
associated_rule_types

Gets the associated_rule_types of this Attribute. Rule types associated with attribute.

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

Returns:The associated_rule_types of this Attribute.
Return type:list[str]
business_name

Gets the business_name of this Attribute. Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.

Returns:The business_name of this Attribute.
Return type:str
created_by_id

Gets the created_by_id of this Attribute. OCID of the user who created this attribute in the data catalog.

Returns:The created_by_id of this Attribute.
Return type:str
custom_property_members

Gets the custom_property_members of this Attribute. The list of customized properties along with the values for this object

Returns:The custom_property_members of this Attribute.
Return type:list[oci.data_catalog.models.CustomPropertyGetUsage]
datatype_entity_key

Gets the datatype_entity_key of this Attribute. Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Returns:The datatype_entity_key of this Attribute.
Return type:str
description

Gets the description of this Attribute. Detailed description of the attribute.

Returns:The description of this Attribute.
Return type:str
display_name

Gets the display_name of this Attribute. 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 Attribute.
Return type:str
entity_key

Gets the entity_key of this Attribute. The unique key of the parent entity.

Returns:The entity_key of this Attribute.
Return type:str
external_data_type

Gets the external_data_type of this Attribute. Data type of the attribute as defined in the external system. Type mapping across systems can be achieved through term associations across domains in the ontology. The attribute can also be tagged to the datatype in the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user defined types.

Returns:The external_data_type of this Attribute.
Return type:str
external_datatype_entity_key

Gets the external_datatype_entity_key of this Attribute. External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Returns:The external_datatype_entity_key of this Attribute.
Return type:str
external_key

Gets the external_key of this Attribute. Unique external key of this attribute in the external source system.

Returns:The external_key of this Attribute.
Return type:str
external_parent_attribute_key

Gets the external_parent_attribute_key of this Attribute. External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.

Returns:The external_parent_attribute_key of this Attribute.
Return type:str
is_derived_attribute

Gets the is_derived_attribute of this Attribute. Whether a column is derived or not.

Returns:The is_derived_attribute of this Attribute.
Return type:bool
is_incremental_data

Gets the is_incremental_data of this Attribute. Property that identifies if this attribute can be used as a watermark to extract incremental data.

Returns:The is_incremental_data of this Attribute.
Return type:bool
is_nullable

Gets the is_nullable of this Attribute. Property that identifies if this attribute can be assigned null values.

Returns:The is_nullable of this Attribute.
Return type:bool
key

[Required] Gets the key of this Attribute. Unique attribute key that is immutable.

Returns:The key of this Attribute.
Return type:str
length

Gets the length of this Attribute. Max allowed length of the attribute value.

Returns:The length of this Attribute.
Return type:int
lifecycle_state

Gets the lifecycle_state of this Attribute. State of the attribute.

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 Attribute.
Return type:str
max_collection_count

Gets the max_collection_count of this Attribute. The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. For type specifications in systems that specify only “capacity” without upper or lower bound , this property can also be used to just mean “capacity”. Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json

Returns:The max_collection_count of this Attribute.
Return type:int
min_collection_count

Gets the min_collection_count of this Attribute. The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

Returns:The min_collection_count of this Attribute.
Return type:int
object_relationships

Gets the object_relationships of this Attribute. List of objects and their relationships to this attribute.

Returns:The object_relationships of this Attribute.
Return type:list[oci.data_catalog.models.ObjectRelationship]
parent_attribute_key

Gets the parent_attribute_key of this Attribute. Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.

Returns:The parent_attribute_key of this Attribute.
Return type:str
path

Gets the path of this Attribute. Full path of the attribute.

Returns:The path of this Attribute.
Return type:str
position

Gets the position of this Attribute. Position of the attribute in the record definition.

Returns:The position of this Attribute.
Return type:int
precision

Gets the precision of this Attribute. Precision of the attribute value usually applies to float data type.

Returns:The precision of this Attribute.
Return type:int
properties

Gets the properties of this Attribute. A map of maps that contains the properties which are specific to the attribute type. Each attribute type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most attributes have required properties within the “default” category. Example: {“properties”: { “default”: { “key1”: “value1”}}}

Returns:The properties of this Attribute.
Return type:dict(str, dict(str, str))
scale

Gets the scale of this Attribute. Scale of the attribute value usually applies to float data type.

Returns:The scale of this Attribute.
Return type:int
time_created

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

Returns:The time_created of this Attribute.
Return type:datetime
time_external

Gets the time_external of this Attribute. Last modified timestamp of this object in the external system.

Returns:The time_external of this Attribute.
Return type:datetime
time_harvested

Gets the time_harvested of this Attribute. The date and time the attribute was harvested, in the format defined by RFC3339.

Returns:The time_harvested of this Attribute.
Return type:datetime
time_updated

Gets the time_updated of this Attribute. The last time that any change was made to the attribute. An RFC3339 formatted datetime string.

Returns:The time_updated of this Attribute.
Return type:datetime
updated_by_id

Gets the updated_by_id of this Attribute. OCID of the user who modified this attribute in the data catalog.

Returns:The updated_by_id of this Attribute.
Return type:str
uri

Gets the uri of this Attribute. URI to the attribute instance in the API.

Returns:The uri of this Attribute.
Return type:str