DataEntityFromObject

class oci.data_integration.models.DataEntityFromObject(**kwargs)

Bases: DataEntity

The Application Object entity data entity details.

Attributes:

ENTITY_TYPE_FILE	A constant which can be used with the entity_type property of a DataEntityFromObject.
ENTITY_TYPE_OBJECT	A constant which can be used with the entity_type property of a DataEntityFromObject.
ENTITY_TYPE_SQL	A constant which can be used with the entity_type property of a DataEntityFromObject.
ENTITY_TYPE_TABLE	A constant which can be used with the entity_type property of a DataEntityFromObject.
ENTITY_TYPE_VIEW	A constant which can be used with the entity_type property of a DataEntityFromObject.
MODEL_TYPE_DATA_STORE_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_DERIVED_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_FILE_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_OBJECT_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_SQL_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_TABLE_ENTITY	A constant which can be used with the model_type property of a DataEntity.
MODEL_TYPE_VIEW_ENTITY	A constant which can be used with the model_type property of a DataEntity.
description	Gets the description of this DataEntityFromObject.
entity_type	Gets the entity_type of this DataEntityFromObject.
external_key	Gets the external_key of this DataEntityFromObject.
foreign_keys	Gets the foreign_keys of this DataEntityFromObject.
identifier	Gets the identifier of this DataEntityFromObject.
key	Gets the key of this DataEntityFromObject.
metadata	Gets the metadata of this DataEntity.
model_type	[Required] Gets the model_type of this DataEntity.
model_version	Gets the model_version of this DataEntityFromObject.
name	Gets the name of this DataEntityFromObject.
object_status	Gets the object_status of this DataEntityFromObject.
object_version	Gets the object_version of this DataEntityFromObject.
other_type_label	Gets the other_type_label of this DataEntityFromObject.
parent_ref	Gets the parent_ref of this DataEntityFromObject.
resource_name	Gets the resource_name of this DataEntityFromObject.
shape	Gets the shape of this DataEntityFromObject.
shape_id	Gets the shape_id of this DataEntityFromObject.
unique_keys	Gets the unique_keys of this DataEntityFromObject.

Methods:

__init__(**kwargs)	Initializes a new DataEntityFromObject 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.

ENTITY_TYPE_FILE = 'FILE'

A constant which can be used with the entity_type property of a DataEntityFromObject. This constant has a value of “FILE”

ENTITY_TYPE_OBJECT = 'OBJECT'

A constant which can be used with the entity_type property of a DataEntityFromObject. This constant has a value of “OBJECT”

ENTITY_TYPE_SQL = 'SQL'

A constant which can be used with the entity_type property of a DataEntityFromObject. This constant has a value of “SQL”

ENTITY_TYPE_TABLE = 'TABLE'

A constant which can be used with the entity_type property of a DataEntityFromObject. This constant has a value of “TABLE”

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a DataEntityFromObject. This constant has a value of “VIEW”

MODEL_TYPE_DATA_STORE_ENTITY = 'DATA_STORE_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “DATA_STORE_ENTITY”

MODEL_TYPE_DERIVED_ENTITY = 'DERIVED_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “DERIVED_ENTITY”

MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “FILE_ENTITY”

MODEL_TYPE_OBJECT_ENTITY = 'OBJECT_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “OBJECT_ENTITY”

MODEL_TYPE_SQL_ENTITY = 'SQL_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “SQL_ENTITY”

MODEL_TYPE_TABLE_ENTITY = 'TABLE_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “TABLE_ENTITY”

MODEL_TYPE_VIEW_ENTITY = 'VIEW_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “VIEW_ENTITY”

__init__(**kwargs)

Initializes a new DataEntityFromObject object with values from keyword arguments. The default value of the model_type attribute of this class is OBJECT_ENTITY and 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 DataEntityFromObject. Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”, “DATA_STORE_ENTITY”, “DERIVED_ENTITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this DataEntityFromObject.

• key (str) – The value to assign to the key property of this DataEntityFromObject.

• model_version (str) – The value to assign to the model_version property of this DataEntityFromObject.

• parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this DataEntityFromObject.

• name (str) – The value to assign to the name property of this DataEntityFromObject.

• description (str) – The value to assign to the description property of this DataEntityFromObject.

• object_version (int) – The value to assign to the object_version property of this DataEntityFromObject.

• external_key (str) – The value to assign to the external_key property of this DataEntityFromObject.

• shape (oci.data_integration.models.Shape) – The value to assign to the shape property of this DataEntityFromObject.

• shape_id (str) – The value to assign to the shape_id property of this DataEntityFromObject.

• entity_type (str) – The value to assign to the entity_type property of this DataEntityFromObject. Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”, “OBJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• other_type_label (str) – The value to assign to the other_type_label property of this DataEntityFromObject.

• unique_keys (list[oci.data_integration.models.UniqueKey]) – The value to assign to the unique_keys property of this DataEntityFromObject.

• foreign_keys (list[oci.data_integration.models.ForeignKey]) – The value to assign to the foreign_keys property of this DataEntityFromObject.

• resource_name (str) – The value to assign to the resource_name property of this DataEntityFromObject.

• object_status (int) – The value to assign to the object_status property of this DataEntityFromObject.

• identifier (str) – The value to assign to the identifier property of this DataEntityFromObject.

property description

Gets the description of this DataEntityFromObject. Detailed description for the object.

Returns

The description of this DataEntityFromObject.

Return type

str

property entity_type

Gets the entity_type of this DataEntityFromObject. The entity type.

Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”, “OBJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The entity_type of this DataEntityFromObject.

Return type

str

property external_key

Gets the external_key of this DataEntityFromObject. The external key for the object

Returns

The external_key of this DataEntityFromObject.

Return type

str

property foreign_keys

Gets the foreign_keys of this DataEntityFromObject. An array of foreign keys.

Returns

The foreign_keys of this DataEntityFromObject.

Return type

list[oci.data_integration.models.ForeignKey]

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 identifier

Gets the identifier of this DataEntityFromObject. Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns

The identifier of this DataEntityFromObject.

Return type

str

property key

Gets the key of this DataEntityFromObject. The object key.

Returns

The key of this DataEntityFromObject.

Return type

str

property metadata

Gets the metadata of this DataEntity.

Returns

The metadata of this DataEntity.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

[Required] Gets the model_type of this DataEntity. The data entity type.

Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”, “DATA_STORE_ENTITY”, “DERIVED_ENTITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this DataEntity.

Return type

str

property model_version

Gets the model_version of this DataEntityFromObject. The object’s model version.

Returns

The model_version of this DataEntityFromObject.

Return type

str

property name

Gets the name of this DataEntityFromObject. 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 DataEntityFromObject.

Return type

str

property object_status

Gets the object_status of this DataEntityFromObject. 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 DataEntityFromObject.

Return type

int

property object_version

Gets the object_version of this DataEntityFromObject. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this DataEntityFromObject.

Return type

int

property other_type_label

Gets the other_type_label of this DataEntityFromObject. Specifies other type label.

Returns

The other_type_label of this DataEntityFromObject.

Return type

str

property parent_ref

Gets the parent_ref of this DataEntityFromObject.

Returns

The parent_ref of this DataEntityFromObject.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this DataEntityFromObject. The resource name.

Returns

The resource_name of this DataEntityFromObject.

Return type

str

property shape

Gets the shape of this DataEntityFromObject.

Returns

The shape of this DataEntityFromObject.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DataEntityFromObject. The shape ID.

Returns

The shape_id of this DataEntityFromObject.

Return type

str

property unique_keys

Gets the unique_keys of this DataEntityFromObject. An array of unique keys.

Returns

The unique_keys of this DataEntityFromObject.

Return type

list[oci.data_integration.models.UniqueKey]