UpdateAttributeDetails¶

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

Bases: object

Properties used in attribute update operations.

Methods

__init__(**kwargs) Initializes a new UpdateAttributeDetails object with values from keyword arguments.

Attributes

`business_name`	Gets the business_name of this UpdateAttributeDetails.
`custom_property_members`	Gets the custom_property_members of this UpdateAttributeDetails.
`description`	Gets the description of this UpdateAttributeDetails.
`display_name`	Gets the display_name of this UpdateAttributeDetails.
`external_data_type`	Gets the external_data_type of this UpdateAttributeDetails.
`external_datatype_entity_key`	Gets the external_datatype_entity_key of this UpdateAttributeDetails.
`external_parent_attribute_key`	Gets the external_parent_attribute_key of this UpdateAttributeDetails.
`is_incremental_data`	Gets the is_incremental_data of this UpdateAttributeDetails.
`is_nullable`	Gets the is_nullable of this UpdateAttributeDetails.
`length`	Gets the length of this UpdateAttributeDetails.
`max_collection_count`	Gets the max_collection_count of this UpdateAttributeDetails.
`min_collection_count`	Gets the min_collection_count of this UpdateAttributeDetails.
`position`	Gets the position of this UpdateAttributeDetails.
`precision`	Gets the precision of this UpdateAttributeDetails.
`properties`	Gets the properties of this UpdateAttributeDetails.
`scale`	Gets the scale of this UpdateAttributeDetails.
`time_external`	Gets the time_external of this UpdateAttributeDetails.

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this UpdateAttributeDetails.
business_name (str) – The value to assign to the business_name property of this UpdateAttributeDetails.
description (str) – The value to assign to the description property of this UpdateAttributeDetails.
external_data_type (str) – The value to assign to the external_data_type property of this UpdateAttributeDetails.
is_incremental_data (bool) – The value to assign to the is_incremental_data property of this UpdateAttributeDetails.
is_nullable (bool) – The value to assign to the is_nullable property of this UpdateAttributeDetails.
length (int) – The value to assign to the length property of this UpdateAttributeDetails.
position (int) – The value to assign to the position property of this UpdateAttributeDetails.
precision (int) – The value to assign to the precision property of this UpdateAttributeDetails.
scale (int) – The value to assign to the scale property of this UpdateAttributeDetails.
time_external (datetime) – The value to assign to the time_external property of this UpdateAttributeDetails.
min_collection_count (int) – The value to assign to the min_collection_count property of this UpdateAttributeDetails.
max_collection_count (int) – The value to assign to the max_collection_count property of this UpdateAttributeDetails.
external_datatype_entity_key (str) – The value to assign to the external_datatype_entity_key property of this UpdateAttributeDetails.
external_parent_attribute_key (str) – The value to assign to the external_parent_attribute_key property of this UpdateAttributeDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this UpdateAttributeDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this UpdateAttributeDetails.

business_name¶

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

custom_property_members¶

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

Returns:	The custom_property_members of this UpdateAttributeDetails.
Return type:	list[oci.data_catalog.models.CustomPropertySetUsage]

description¶

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

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

display_name¶

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

external_data_type¶

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

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

external_datatype_entity_key¶

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

external_parent_attribute_key¶

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

is_incremental_data¶

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

Returns:	The is_incremental_data of this UpdateAttributeDetails.
Return type:	bool

is_nullable¶

Gets the is_nullable of this UpdateAttributeDetails. Property that identifies if this attribute can be assigned nullable values.

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

length¶

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

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

max_collection_count¶

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

min_collection_count¶

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

position¶

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

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

precision¶

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

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

properties¶

Gets the properties of this UpdateAttributeDetails. 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. To determine the set of required and optional properties for an Attribute type, a query can be done on ‘/types?type=attribute’ which returns a collection of all attribute types. The appropriate attribute type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “key1”: “value1”}}}

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

scale¶

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

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

time_external¶

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

Returns:	The time_external of this UpdateAttributeDetails.
Return type:	datetime