CreateEntityShapeFromFile

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

Bases: CreateEntityShapeDetails

The file data entity details.

Attributes:

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OTHER

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

ENTITY_TYPE_QUEUE

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

ENTITY_TYPE_STREAM

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

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

description

Gets the description of this CreateEntityShapeFromFile.

entity_type

Gets the entity_type of this CreateEntityShapeFromFile.

external_key

Gets the external_key of this CreateEntityShapeFromFile.

foreign_keys

Gets the foreign_keys of this CreateEntityShapeFromFile.

identifier

Gets the identifier of this CreateEntityShapeFromFile.

key

Gets the key of this CreateEntityShapeFromFile.

model_type

[Required] Gets the model_type of this CreateEntityShapeDetails.

model_version

Gets the model_version of this CreateEntityShapeFromFile.

name

Gets the name of this CreateEntityShapeFromFile.

object_status

Gets the object_status of this CreateEntityShapeFromFile.

object_version

Gets the object_version of this CreateEntityShapeFromFile.

other_type_label

Gets the other_type_label of this CreateEntityShapeFromFile.

parent_ref

Gets the parent_ref of this CreateEntityShapeFromFile.

resource_name

Gets the resource_name of this CreateEntityShapeFromFile.

shape

Gets the shape of this CreateEntityShapeFromFile.

shape_id

Gets the shape_id of this CreateEntityShapeFromFile.

types

Gets the types of this CreateEntityShapeFromFile.

unique_keys

Gets the unique_keys of this CreateEntityShapeFromFile.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a CreateEntityShapeFromFile. 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 CreateEntityShapeFromFile object with values from keyword arguments. The default value of the model_type attribute of this class is FILE_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 CreateEntityShapeFromFile. Allowed values for this property are: “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”

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

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

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

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

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

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

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

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

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

  • types (oci.data_integration.models.TypeLibrary) – The value to assign to the types property of this CreateEntityShapeFromFile.

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

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

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

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

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

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

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

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

property data_format

Gets the data_format of this CreateEntityShapeFromFile.

Returns

The data_format of this CreateEntityShapeFromFile.

Return type

oci.data_integration.models.DataFormat

property description

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

Returns

The description of this CreateEntityShapeFromFile.

Return type

str

property entity_type

Gets the entity_type of this CreateEntityShapeFromFile. The entity type.

Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “QUEUE”, “STREAM”, “OTHER”

Returns

The entity_type of this CreateEntityShapeFromFile.

Return type

str

property external_key

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

Returns

The external_key of this CreateEntityShapeFromFile.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this CreateEntityShapeFromFile.

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

Return type

str

property key

Gets the key of this CreateEntityShapeFromFile. The object key.

Returns

The key of this CreateEntityShapeFromFile.

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

Returns

The model_version of this CreateEntityShapeFromFile.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this CreateEntityShapeFromFile.

Return type

int

property other_type_label

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

Returns

The other_type_label of this CreateEntityShapeFromFile.

Return type

str

property parent_ref

Gets the parent_ref of this CreateEntityShapeFromFile.

Returns

The parent_ref of this CreateEntityShapeFromFile.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this CreateEntityShapeFromFile. The resource name.

Returns

The resource_name of this CreateEntityShapeFromFile.

Return type

str

property shape

Gets the shape of this CreateEntityShapeFromFile.

Returns

The shape of this CreateEntityShapeFromFile.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this CreateEntityShapeFromFile. The shape ID.

Returns

The shape_id of this CreateEntityShapeFromFile.

Return type

str

property types

Gets the types of this CreateEntityShapeFromFile.

Returns

The types of this CreateEntityShapeFromFile.

Return type

oci.data_integration.models.TypeLibrary

property unique_keys

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

Returns

The unique_keys of this CreateEntityShapeFromFile.

Return type

list[oci.data_integration.models.UniqueKey]