DataEntityFromSql

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

Bases: DataEntity

The sql entity data entity details.

Attributes:

ENTITY_TYPE_FILE	A constant which can be used with the entity_type property of a DataEntityFromSql.
ENTITY_TYPE_SQL	A constant which can be used with the entity_type property of a DataEntityFromSql.
ENTITY_TYPE_TABLE	A constant which can be used with the entity_type property of a DataEntityFromSql.
ENTITY_TYPE_VIEW	A constant which can be used with the entity_type property of a DataEntityFromSql.
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 DataEntityFromSql.
entity_type	Gets the entity_type of this DataEntityFromSql.
external_key	Gets the external_key of this DataEntityFromSql.
foreign_keys	Gets the foreign_keys of this DataEntityFromSql.
identifier	Gets the identifier of this DataEntityFromSql.
key	Gets the key of this DataEntityFromSql.
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 DataEntityFromSql.
name	Gets the name of this DataEntityFromSql.
object_status	Gets the object_status of this DataEntityFromSql.
object_version	Gets the object_version of this DataEntityFromSql.
other_type_label	Gets the other_type_label of this DataEntityFromSql.
parent_ref	Gets the parent_ref of this DataEntityFromSql.
resource_name	Gets the resource_name of this DataEntityFromSql.
shape	Gets the shape of this DataEntityFromSql.
shape_id	Gets the shape_id of this DataEntityFromSql.
sql_query	Gets the sql_query of this DataEntityFromSql.
unique_keys	Gets the unique_keys of this DataEntityFromSql.

Methods:

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

ENTITY_TYPE_SQL = 'SQL'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a DataEntityFromSql. 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 DataEntityFromSql object with values from keyword arguments. The default value of the model_type attribute of this class is SQL_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 DataEntityFromSql. 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 DataEntityFromSql.

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

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

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

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

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

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

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

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

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

• entity_type (str) – The value to assign to the entity_type property of this DataEntityFromSql. Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”, ‘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 DataEntityFromSql.

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

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

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

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

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

• sql_query (str) – The value to assign to the sql_query property of this DataEntityFromSql.

property description

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

Returns

The description of this DataEntityFromSql.

Return type

str

property entity_type

Gets the entity_type of this DataEntityFromSql. The entity type.

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

Returns

The entity_type of this DataEntityFromSql.

Return type

str

property external_key

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

Returns

The external_key of this DataEntityFromSql.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this DataEntityFromSql.

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 DataEntityFromSql. 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 DataEntityFromSql.

Return type

str

property key

Gets the key of this DataEntityFromSql. The object key.

Returns

The key of this DataEntityFromSql.

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 DataEntityFromSql. The object’s model version.

Returns

The model_version of this DataEntityFromSql.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this DataEntityFromSql.

Return type

int

property other_type_label

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

Returns

The other_type_label of this DataEntityFromSql.

Return type

str

property parent_ref

Gets the parent_ref of this DataEntityFromSql.

Returns

The parent_ref of this DataEntityFromSql.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this DataEntityFromSql. The resource name.

Returns

The resource_name of this DataEntityFromSql.

Return type

str

property shape

Gets the shape of this DataEntityFromSql.

Returns

The shape of this DataEntityFromSql.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DataEntityFromSql. The shape ID.

Returns

The shape_id of this DataEntityFromSql.

Return type

str

property sql_query

Gets the sql_query of this DataEntityFromSql. sqlQuery

Returns

The sql_query of this DataEntityFromSql.

Return type

str

property unique_keys

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

Returns

The unique_keys of this DataEntityFromSql.

Return type

list[oci.data_integration.models.UniqueKey]