EntityShapeFromSQL¶

class oci.data_integration.models.EntityShapeFromSQL(**kwargs)¶

Bases: oci.data_integration.models.entity_shape.EntityShape

The SQL entity details.

Attributes

`ENTITY_TYPE_FILE`	A constant which can be used with the entity_type property of a EntityShapeFromSQL.
`ENTITY_TYPE_SQL`	A constant which can be used with the entity_type property of a EntityShapeFromSQL.
`ENTITY_TYPE_TABLE`	A constant which can be used with the entity_type property of a EntityShapeFromSQL.
`ENTITY_TYPE_VIEW`	A constant which can be used with the entity_type property of a EntityShapeFromSQL.
`MODEL_TYPE_FILE_ENTITY`	str(object=’’) -> str
`MODEL_TYPE_OBJECT_ENTITY`	str(object=’’) -> str
`MODEL_TYPE_SQL_ENTITY`	str(object=’’) -> str
`data_format`	Gets the data_format of this EntityShapeFromSQL.
`description`	Gets the description of this EntityShapeFromSQL.
`entity_type`	Gets the entity_type of this EntityShapeFromSQL.
`external_key`	Gets the external_key of this EntityShapeFromSQL.
`foreign_keys`	Gets the foreign_keys of this EntityShapeFromSQL.
`identifier`	Gets the identifier of this EntityShapeFromSQL.
`key`	Gets the key of this EntityShapeFromSQL.
`metadata`	Gets the metadata of this EntityShape.
`model_type`	[Required] Gets the model_type of this EntityShape.
`model_version`	Gets the model_version of this EntityShapeFromSQL.
`name`	Gets the name of this EntityShapeFromSQL.
`object_status`	Gets the object_status of this EntityShapeFromSQL.
`object_version`	Gets the object_version of this EntityShapeFromSQL.
`other_type_label`	Gets the other_type_label of this EntityShapeFromSQL.
`parent_ref`	Gets the parent_ref of this EntityShapeFromSQL.
`resource_name`	Gets the resource_name of this EntityShapeFromSQL.
`shape`	Gets the shape of this EntityShapeFromSQL.
`shape_id`	Gets the shape_id of this EntityShapeFromSQL.
`sql_query`	Gets the sql_query of this EntityShapeFromSQL.
`unique_keys`	Gets the unique_keys of this EntityShapeFromSQL.

Methods

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

ENTITY_TYPE_SQL = 'SQL'¶: A constant which can be used with the entity_type property of a EntityShapeFromSQL. This constant has a value of “SQL”

ENTITY_TYPE_TABLE = 'TABLE'¶: A constant which can be used with the entity_type property of a EntityShapeFromSQL. This constant has a value of “TABLE”

ENTITY_TYPE_VIEW = 'VIEW'¶: A constant which can be used with the entity_type property of a EntityShapeFromSQL. This constant has a value of “VIEW”

MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'¶

MODEL_TYPE_OBJECT_ENTITY = 'OBJECT_ENTITY'¶

MODEL_TYPE_SQL_ENTITY = 'SQL_ENTITY'¶

__init__(**kwargs)¶

Initializes a new EntityShapeFromSQL 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 EntityShapeFromSQL. Allowed values for this property are: “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_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 EntityShapeFromSQL.
key (str) – The value to assign to the key property of this EntityShapeFromSQL.
model_version (str) – The value to assign to the model_version property of this EntityShapeFromSQL.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this EntityShapeFromSQL.
name (str) – The value to assign to the name property of this EntityShapeFromSQL.
description (str) – The value to assign to the description property of this EntityShapeFromSQL.
object_version (int) – The value to assign to the object_version property of this EntityShapeFromSQL.
external_key (str) – The value to assign to the external_key property of this EntityShapeFromSQL.
shape (oci.data_integration.models.Shape) – The value to assign to the shape property of this EntityShapeFromSQL.
shape_id (str) – The value to assign to the shape_id property of this EntityShapeFromSQL.
entity_type (str) – The value to assign to the entity_type property of this EntityShapeFromSQL. 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 EntityShapeFromSQL.
unique_keys (list[oci.data_integration.models.UniqueKey]) – The value to assign to the unique_keys property of this EntityShapeFromSQL.
foreign_keys (list[oci.data_integration.models.ForeignKey]) – The value to assign to the foreign_keys property of this EntityShapeFromSQL.
resource_name (str) – The value to assign to the resource_name property of this EntityShapeFromSQL.
data_format (oci.data_integration.models.DataFormat) – The value to assign to the data_format property of this EntityShapeFromSQL.
object_status (int) – The value to assign to the object_status property of this EntityShapeFromSQL.
identifier (str) – The value to assign to the identifier property of this EntityShapeFromSQL.
sql_query (str) – The value to assign to the sql_query property of this EntityShapeFromSQL.

data_format¶

Gets the data_format of this EntityShapeFromSQL.

Returns:	The data_format of this EntityShapeFromSQL.
Return type:	oci.data_integration.models.DataFormat

description¶

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

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

entity_type¶

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

external_key¶

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

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

foreign_keys¶

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

Returns:	The foreign_keys of this EntityShapeFromSQL.
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.

identifier¶

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

key¶

Gets the key of this EntityShapeFromSQL. The object key.

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

metadata¶

Gets the metadata of this EntityShape.

Returns:	The metadata of this EntityShape.
Return type:	oci.data_integration.models.ObjectMetadata

model_type¶

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

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

Returns:	The model_type of this EntityShape.
Return type:	str

model_version¶

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

Returns:	The model_version of this EntityShapeFromSQL.
Return type:	str

name¶

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

object_status¶

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

object_version¶

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

Returns:	The object_version of this EntityShapeFromSQL.
Return type:	int

other_type_label¶

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

Returns:	The other_type_label of this EntityShapeFromSQL.
Return type:	str

parent_ref¶

Gets the parent_ref of this EntityShapeFromSQL.

Returns:	The parent_ref of this EntityShapeFromSQL.
Return type:	oci.data_integration.models.ParentReference

resource_name¶

Gets the resource_name of this EntityShapeFromSQL. The resource name.

Returns:	The resource_name of this EntityShapeFromSQL.
Return type:	str

shape¶

Gets the shape of this EntityShapeFromSQL.

Returns:	The shape of this EntityShapeFromSQL.
Return type:	oci.data_integration.models.Shape

shape_id¶

Gets the shape_id of this EntityShapeFromSQL. The shape ID.

Returns:	The shape_id of this EntityShapeFromSQL.
Return type:	str

sql_query¶

Gets the sql_query of this EntityShapeFromSQL. sqlQuery

Returns:	The sql_query of this EntityShapeFromSQL.
Return type:	str

unique_keys¶

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

Returns:	The unique_keys of this EntityShapeFromSQL.
Return type:	list[oci.data_integration.models.UniqueKey]