CreateAttributeDetails¶

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

Bases: object

Properties used in attribute create operations.

Methods

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

Attributes

`business_name`	Gets the business_name of this CreateAttributeDetails.
`custom_property_members`	Gets the custom_property_members of this CreateAttributeDetails.
`description`	Gets the description of this CreateAttributeDetails.
`display_name`	[Required] Gets the display_name of this CreateAttributeDetails.
`external_data_type`	[Required] Gets the external_data_type of this CreateAttributeDetails.
`external_datatype_entity_key`	Gets the external_datatype_entity_key of this CreateAttributeDetails.
`external_parent_attribute_key`	Gets the external_parent_attribute_key of this CreateAttributeDetails.
`is_incremental_data`	Gets the is_incremental_data of this CreateAttributeDetails.
`is_nullable`	Gets the is_nullable of this CreateAttributeDetails.
`length`	Gets the length of this CreateAttributeDetails.
`max_collection_count`	Gets the max_collection_count of this CreateAttributeDetails.
`min_collection_count`	Gets the min_collection_count of this CreateAttributeDetails.
`position`	Gets the position of this CreateAttributeDetails.
`precision`	Gets the precision of this CreateAttributeDetails.
`properties`	Gets the properties of this CreateAttributeDetails.
`scale`	Gets the scale of this CreateAttributeDetails.
`time_external`	[Required] Gets the time_external of this CreateAttributeDetails.
`type_key`	Gets the type_key of this CreateAttributeDetails.

__init__(**kwargs)¶

Initializes a new CreateAttributeDetails 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 CreateAttributeDetails.
business_name (str) – The value to assign to the business_name property of this CreateAttributeDetails.
description (str) – The value to assign to the description property of this CreateAttributeDetails.
external_data_type (str) – The value to assign to the external_data_type property of this CreateAttributeDetails.
is_incremental_data (bool) – The value to assign to the is_incremental_data property of this CreateAttributeDetails.
is_nullable (bool) – The value to assign to the is_nullable property of this CreateAttributeDetails.
length (int) – The value to assign to the length property of this CreateAttributeDetails.
position (int) – The value to assign to the position property of this CreateAttributeDetails.
precision (int) – The value to assign to the precision property of this CreateAttributeDetails.
scale (int) – The value to assign to the scale property of this CreateAttributeDetails.
time_external (datetime) – The value to assign to the time_external property of this CreateAttributeDetails.
min_collection_count (int) – The value to assign to the min_collection_count property of this CreateAttributeDetails.
max_collection_count (int) – The value to assign to the max_collection_count property of this CreateAttributeDetails.
external_datatype_entity_key (str) – The value to assign to the external_datatype_entity_key property of this CreateAttributeDetails.
external_parent_attribute_key (str) – The value to assign to the external_parent_attribute_key property of this CreateAttributeDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this CreateAttributeDetails.
type_key (str) – The value to assign to the type_key property of this CreateAttributeDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateAttributeDetails.

business_name¶

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

custom_property_members¶

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

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this CreateAttributeDetails. 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 CreateAttributeDetails.
Return type:	str

external_data_type¶

[Required] Gets the external_data_type of this CreateAttributeDetails. Data type of the attribute as defined in the external system.

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

external_datatype_entity_key¶

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

external_parent_attribute_key¶

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

is_incremental_data¶

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

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

is_nullable¶

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

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

length¶

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

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

max_collection_count¶

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

min_collection_count¶

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

position¶

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

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

precision¶

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

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

properties¶

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

scale¶

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

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

time_external¶

[Required] Gets the time_external of this CreateAttributeDetails. Last modified timestamp of this object in the external system.

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

type_key¶

Gets the type_key of this CreateAttributeDetails. Type key of the object. Type keys can be found via the ‘/types’ endpoint.

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