CreateEntityShapeFromSQL

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

Bases: CreateEntityShapeDetails

The SQL entity details.

Attributes:

ENTITY_TYPE_FILE

A constant which can be used with the entity_type property of a CreateEntityShapeFromSQL.

ENTITY_TYPE_SQL

A constant which can be used with the entity_type property of a CreateEntityShapeFromSQL.

ENTITY_TYPE_TABLE

A constant which can be used with the entity_type property of a CreateEntityShapeFromSQL.

ENTITY_TYPE_VIEW

A constant which can be used with the entity_type property of a CreateEntityShapeFromSQL.

MODEL_TYPE_FILE_ENTITY

A constant which can be used with the model_type property of a CreateEntityShapeDetails.

MODEL_TYPE_OBJECT_ENTITY

A constant which can be used with the model_type property of a CreateEntityShapeDetails.

MODEL_TYPE_SQL_ENTITY

A constant which can be used with the model_type property of a CreateEntityShapeDetails.

data_format

Gets the data_format of this CreateEntityShapeFromSQL.

description

Gets the description of this CreateEntityShapeFromSQL.

entity_type

Gets the entity_type of this CreateEntityShapeFromSQL.

external_key

Gets the external_key of this CreateEntityShapeFromSQL.

foreign_keys

Gets the foreign_keys of this CreateEntityShapeFromSQL.

identifier

Gets the identifier of this CreateEntityShapeFromSQL.

key

Gets the key of this CreateEntityShapeFromSQL.

model_type

[Required] Gets the model_type of this CreateEntityShapeDetails.

model_version

Gets the model_version of this CreateEntityShapeFromSQL.

name

Gets the name of this CreateEntityShapeFromSQL.

object_status

Gets the object_status of this CreateEntityShapeFromSQL.

object_version

Gets the object_version of this CreateEntityShapeFromSQL.

other_type_label

Gets the other_type_label of this CreateEntityShapeFromSQL.

parent_ref

Gets the parent_ref of this CreateEntityShapeFromSQL.

resource_name

Gets the resource_name of this CreateEntityShapeFromSQL.

shape

Gets the shape of this CreateEntityShapeFromSQL.

shape_id

Gets the shape_id of this CreateEntityShapeFromSQL.

sql_query

Gets the sql_query of this CreateEntityShapeFromSQL.

unique_keys

Gets the unique_keys of this CreateEntityShapeFromSQL.

Methods:

__init__(**kwargs)

Initializes a new CreateEntityShapeFromSQL 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 CreateEntityShapeFromSQL. This constant has a value of “FILE”

ENTITY_TYPE_SQL = 'SQL'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'

A constant which can be used with the model_type property of a CreateEntityShapeDetails. 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 CreateEntityShapeDetails. 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 CreateEntityShapeDetails. This constant has a value of “SQL_ENTITY”

__init__(**kwargs)

Initializes a new CreateEntityShapeFromSQL 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 CreateEntityShapeFromSQL. Allowed values for this property are: “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”

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

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

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

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

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

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

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

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

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

  • entity_type (str) – The value to assign to the entity_type property of this CreateEntityShapeFromSQL. Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”

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

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

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

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

  • data_format (oci.data_integration.models.DataFormat) – The value to assign to the data_format property of this CreateEntityShapeFromSQL.

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

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

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

property data_format

Gets the data_format of this CreateEntityShapeFromSQL.

Returns

The data_format of this CreateEntityShapeFromSQL.

Return type

oci.data_integration.models.DataFormat

property description

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

Returns

The description of this CreateEntityShapeFromSQL.

Return type

str

property entity_type

Gets the entity_type of this CreateEntityShapeFromSQL. The entity type.

Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”

Returns

The entity_type of this CreateEntityShapeFromSQL.

Return type

str

property external_key

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

Returns

The external_key of this CreateEntityShapeFromSQL.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this CreateEntityShapeFromSQL.

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

Return type

str

property key

Gets the key of this CreateEntityShapeFromSQL. The object key.

Returns

The key of this CreateEntityShapeFromSQL.

Return type

str

property model_type

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

Allowed values for this property are: “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”

Returns

The model_type of this CreateEntityShapeDetails.

Return type

str

property model_version

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

Returns

The model_version of this CreateEntityShapeFromSQL.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this CreateEntityShapeFromSQL.

Return type

int

property other_type_label

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

Returns

The other_type_label of this CreateEntityShapeFromSQL.

Return type

str

property parent_ref

Gets the parent_ref of this CreateEntityShapeFromSQL.

Returns

The parent_ref of this CreateEntityShapeFromSQL.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this CreateEntityShapeFromSQL. The resource name.

Returns

The resource_name of this CreateEntityShapeFromSQL.

Return type

str

property shape

Gets the shape of this CreateEntityShapeFromSQL.

Returns

The shape of this CreateEntityShapeFromSQL.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this CreateEntityShapeFromSQL. The shape ID.

Returns

The shape_id of this CreateEntityShapeFromSQL.

Return type

str

property sql_query

Gets the sql_query of this CreateEntityShapeFromSQL. sqlQuery

Returns

The sql_query of this CreateEntityShapeFromSQL.

Return type

str

property unique_keys

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

Returns

The unique_keys of this CreateEntityShapeFromSQL.

Return type

list[oci.data_integration.models.UniqueKey]