CreateEntityShapeFromObject

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

Bases: CreateEntityShapeDetails

The application object entity details.

Attributes:

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OBJECT

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

ENTITY_TYPE_SQL

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

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

description

Gets the description of this CreateEntityShapeFromObject.

entity_type

Gets the entity_type of this CreateEntityShapeFromObject.

external_key

Gets the external_key of this CreateEntityShapeFromObject.

foreign_keys

Gets the foreign_keys of this CreateEntityShapeFromObject.

identifier

Gets the identifier of this CreateEntityShapeFromObject.

key

Gets the key of this CreateEntityShapeFromObject.

model_type

[Required] Gets the model_type of this CreateEntityShapeDetails.

name

[Required] Gets the name of this CreateEntityShapeFromObject.

other_type_label

Gets the other_type_label of this CreateEntityShapeFromObject.

parent_ref

Gets the parent_ref of this CreateEntityShapeFromObject.

resource_name

Gets the resource_name of this CreateEntityShapeFromObject.

shape

Gets the shape of this CreateEntityShapeFromObject.

shape_id

Gets the shape_id of this CreateEntityShapeFromObject.

unique_keys

Gets the unique_keys of this CreateEntityShapeFromObject.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_OBJECT = 'OBJECT'

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

ENTITY_TYPE_SQL = 'SQL'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a CreateEntityShapeFromObject. 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 CreateEntityShapeFromObject 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 CreateEntityShapeFromObject. Allowed values for this property are: “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property data_format

Gets the data_format of this CreateEntityShapeFromObject.

Returns

The data_format of this CreateEntityShapeFromObject.

Return type

oci.data_integration.models.DataFormat

property description

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

Returns

The description of this CreateEntityShapeFromObject.

Return type

str

property entity_type

Gets the entity_type of this CreateEntityShapeFromObject. The entity type.

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

Returns

The entity_type of this CreateEntityShapeFromObject.

Return type

str

property external_key

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

Returns

The external_key of this CreateEntityShapeFromObject.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this CreateEntityShapeFromObject.

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

Return type

str

property key

Gets the key of this CreateEntityShapeFromObject. The object key.

Returns

The key of this CreateEntityShapeFromObject.

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 name

[Required] Gets the name of this CreateEntityShapeFromObject. 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 CreateEntityShapeFromObject.

Return type

str

property other_type_label

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

Returns

The other_type_label of this CreateEntityShapeFromObject.

Return type

str

property parent_ref

Gets the parent_ref of this CreateEntityShapeFromObject.

Returns

The parent_ref of this CreateEntityShapeFromObject.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this CreateEntityShapeFromObject. The resource name.

Returns

The resource_name of this CreateEntityShapeFromObject.

Return type

str

property shape

Gets the shape of this CreateEntityShapeFromObject.

Returns

The shape of this CreateEntityShapeFromObject.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this CreateEntityShapeFromObject. The shape ID.

Returns

The shape_id of this CreateEntityShapeFromObject.

Return type

str

property unique_keys

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

Returns

The unique_keys of this CreateEntityShapeFromObject.

Return type

list[oci.data_integration.models.UniqueKey]