EntityShapeFromFile

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

Bases: EntityShape

The file data entity details.

Attributes:

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OTHER

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

ENTITY_TYPE_QUEUE

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

ENTITY_TYPE_STREAM

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

MODEL_TYPE_FILE_ENTITY

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

MODEL_TYPE_OBJECT_ENTITY

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

MODEL_TYPE_SQL_ENTITY

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

data_format

Gets the data_format of this EntityShapeFromFile.

description

Gets the description of this EntityShapeFromFile.

entity_type

Gets the entity_type of this EntityShapeFromFile.

external_key

Gets the external_key of this EntityShapeFromFile.

foreign_keys

Gets the foreign_keys of this EntityShapeFromFile.

identifier

Gets the identifier of this EntityShapeFromFile.

key

Gets the key of this EntityShapeFromFile.

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

name

Gets the name of this EntityShapeFromFile.

object_status

Gets the object_status of this EntityShapeFromFile.

object_version

Gets the object_version of this EntityShapeFromFile.

other_type_label

Gets the other_type_label of this EntityShapeFromFile.

parent_ref

Gets the parent_ref of this EntityShapeFromFile.

resource_name

Gets the resource_name of this EntityShapeFromFile.

shape

Gets the shape of this EntityShapeFromFile.

shape_id

Gets the shape_id of this EntityShapeFromFile.

types

Gets the types of this EntityShapeFromFile.

unique_keys

Gets the unique_keys of this EntityShapeFromFile.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

__init__(**kwargs)

Initializes a new EntityShapeFromFile 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 EntityShapeFromFile. 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 EntityShapeFromFile.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property data_format

Gets the data_format of this EntityShapeFromFile.

Returns

The data_format of this EntityShapeFromFile.

Return type

oci.data_integration.models.DataFormat

property description

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

Returns

The description of this EntityShapeFromFile.

Return type

str

property entity_type

Gets the entity_type of this EntityShapeFromFile. The entity type.

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

Returns

The entity_type of this EntityShapeFromFile.

Return type

str

property external_key

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

Returns

The external_key of this EntityShapeFromFile.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this EntityShapeFromFile.

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

Return type

str

property key

Gets the key of this EntityShapeFromFile. The object key.

Returns

The key of this EntityShapeFromFile.

Return type

str

property metadata

Gets the metadata of this EntityShape.

Returns

The metadata of this EntityShape.

Return type

oci.data_integration.models.ObjectMetadata

property 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

property model_version

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

Returns

The model_version of this EntityShapeFromFile.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this EntityShapeFromFile.

Return type

int

property other_type_label

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

Returns

The other_type_label of this EntityShapeFromFile.

Return type

str

property parent_ref

Gets the parent_ref of this EntityShapeFromFile.

Returns

The parent_ref of this EntityShapeFromFile.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this EntityShapeFromFile. The resource name.

Returns

The resource_name of this EntityShapeFromFile.

Return type

str

property shape

Gets the shape of this EntityShapeFromFile.

Returns

The shape of this EntityShapeFromFile.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this EntityShapeFromFile. The shape ID.

Returns

The shape_id of this EntityShapeFromFile.

Return type

str

property types

Gets the types of this EntityShapeFromFile.

Returns

The types of this EntityShapeFromFile.

Return type

oci.data_integration.models.TypeLibrary

property unique_keys

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

Returns

The unique_keys of this EntityShapeFromFile.

Return type

list[oci.data_integration.models.UniqueKey]