AttributeSummary¶

class oci.data_catalog.models.AttributeSummary(**kwargs)¶

Bases: object

Summary of an entity attribute.

Attributes

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

Methods

__init__(**kwargs) Initializes a new AttributeSummary 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 AttributeSummary. 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 AttributeSummary. 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 AttributeSummary. This constant has a value of “UNIQUEKEY”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a AttributeSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new AttributeSummary 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 AttributeSummary.
display_name (str) – The value to assign to the display_name property of this AttributeSummary.
business_name (str) – The value to assign to the business_name property of this AttributeSummary.
description (str) – The value to assign to the description property of this AttributeSummary.
entity_key (str) – The value to assign to the entity_key property of this AttributeSummary.
external_key (str) – The value to assign to the external_key property of this AttributeSummary.
length (int) – The value to assign to the length property of this AttributeSummary.
position (int) – The value to assign to the position property of this AttributeSummary.
precision (int) – The value to assign to the precision property of this AttributeSummary.
scale (int) – The value to assign to the scale property of this AttributeSummary.
is_nullable (bool) – The value to assign to the is_nullable property of this AttributeSummary.
uri (str) – The value to assign to the uri property of this AttributeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AttributeSummary. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this AttributeSummary.
time_created (datetime) – The value to assign to the time_created property of this AttributeSummary.
external_data_type (str) – The value to assign to the external_data_type property of this AttributeSummary.
type_key (str) – The value to assign to the type_key property of this AttributeSummary.
min_collection_count (int) – The value to assign to the min_collection_count property of this AttributeSummary.
max_collection_count (int) – The value to assign to the max_collection_count property of this AttributeSummary.
datatype_entity_key (str) – The value to assign to the datatype_entity_key property of this AttributeSummary.
external_datatype_entity_key (str) – The value to assign to the external_datatype_entity_key property of this AttributeSummary.
parent_attribute_key (str) – The value to assign to the parent_attribute_key property of this AttributeSummary.
external_parent_attribute_key (str) – The value to assign to the external_parent_attribute_key property of this AttributeSummary.
path (str) – The value to assign to the path property of this AttributeSummary.
custom_property_members (list[oci.data_catalog.models.CustomPropertyGetUsage]) – The value to assign to the custom_property_members property of this AttributeSummary.
associated_rule_types (list[str]) – The value to assign to the associated_rule_types property of this AttributeSummary. 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’.
is_derived_attribute (bool) – The value to assign to the is_derived_attribute property of this AttributeSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AttributeSummary.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this AttributeSummary.

associated_rule_types¶

Gets the associated_rule_types of this AttributeSummary. 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 AttributeSummary.
Return type:	list[str]

business_name¶

Gets the business_name of this AttributeSummary. 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 AttributeSummary.
Return type:	str

custom_property_members¶

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

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

datatype_entity_key¶

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

Returns:	The datatype_entity_key of this AttributeSummary.
Return type:	str

description¶

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

Returns:	The description of this AttributeSummary.
Return type:	str

display_name¶

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

entity_key¶

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

Returns:	The entity_key of this AttributeSummary.
Return type:	str

external_data_type¶

Gets the external_data_type of this AttributeSummary. Data type of the attribute as defined in the external source system.

Returns:	The external_data_type of this AttributeSummary.
Return type:	str

external_datatype_entity_key¶

Gets the external_datatype_entity_key of this AttributeSummary. 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 AttributeSummary.
Return type:	str

external_key¶

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

Returns:	The external_key of this AttributeSummary.
Return type:	str

external_parent_attribute_key¶

Gets the external_parent_attribute_key of this AttributeSummary. 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 AttributeSummary.
Return type:	str

is_derived_attribute¶

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

Returns:	The is_derived_attribute of this AttributeSummary.
Return type:	bool

is_nullable¶

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

Returns:	The is_nullable of this AttributeSummary.
Return type:	bool

key¶

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

Returns:	The key of this AttributeSummary.
Return type:	str

length¶

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

Returns:	The length of this AttributeSummary.
Return type:	int

lifecycle_details¶

Gets the lifecycle_details of this AttributeSummary. A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

Returns:	The lifecycle_details of this AttributeSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this AttributeSummary. 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 AttributeSummary.
Return type:	str

max_collection_count¶

Gets the max_collection_count of this AttributeSummary. 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 AttributeSummary.
Return type:	int

min_collection_count¶

Gets the min_collection_count of this AttributeSummary. 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 AttributeSummary.
Return type:	int

parent_attribute_key¶

Gets the parent_attribute_key of this AttributeSummary. 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 AttributeSummary.
Return type:	str

path¶

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

Returns:	The path of this AttributeSummary.
Return type:	str

position¶

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

Returns:	The position of this AttributeSummary.
Return type:	int

precision¶

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

Returns:	The precision of this AttributeSummary.
Return type:	int

properties¶

Gets the properties of this AttributeSummary. 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 AttributeSummary.
Return type:	dict(str, dict(str, str))

scale¶

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

Returns:	The scale of this AttributeSummary.
Return type:	int

time_created¶

Gets the time_created of this AttributeSummary. 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 AttributeSummary.
Return type:	datetime

time_updated¶

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

Returns:	The time_updated of this AttributeSummary.
Return type:	datetime

type_key¶

Gets the type_key of this AttributeSummary. The type of the attribute. Type keys can be found via the ‘/types’ endpoint.

Returns:	The type_key of this AttributeSummary.
Return type:	str

uri¶

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

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