DataEntityFromFileEntityDetails

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

Bases: DataEntityDetails

The file data entity details.

Attributes:

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OTHER

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

ENTITY_TYPE_QUEUE

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

ENTITY_TYPE_STREAM

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

MODEL_TYPE_DATA_STORE_ENTITY

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

MODEL_TYPE_FILE_ENTITY

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

MODEL_TYPE_OBJECT_ENTITY

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

MODEL_TYPE_SQL_ENTITY

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

MODEL_TYPE_TABLE_ENTITY

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

MODEL_TYPE_VIEW_ENTITY

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

data_format

Gets the data_format of this DataEntityFromFileEntityDetails.

description

Gets the description of this DataEntityFromFileEntityDetails.

entity_type

Gets the entity_type of this DataEntityFromFileEntityDetails.

external_key

Gets the external_key of this DataEntityFromFileEntityDetails.

foreign_keys

Gets the foreign_keys of this DataEntityFromFileEntityDetails.

identifier

Gets the identifier of this DataEntityFromFileEntityDetails.

key

Gets the key of this DataEntityFromFileEntityDetails.

model_type

[Required] Gets the model_type of this DataEntityDetails.

model_version

Gets the model_version of this DataEntityFromFileEntityDetails.

name

Gets the name of this DataEntityFromFileEntityDetails.

object_status

Gets the object_status of this DataEntityFromFileEntityDetails.

object_version

Gets the object_version of this DataEntityFromFileEntityDetails.

other_type_label

Gets the other_type_label of this DataEntityFromFileEntityDetails.

parent_ref

Gets the parent_ref of this DataEntityFromFileEntityDetails.

resource_name

Gets the resource_name of this DataEntityFromFileEntityDetails.

shape

Gets the shape of this DataEntityFromFileEntityDetails.

shape_id

Gets the shape_id of this DataEntityFromFileEntityDetails.

types

Gets the types of this DataEntityFromFileEntityDetails.

unique_keys

Gets the unique_keys of this DataEntityFromFileEntityDetails.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

MODEL_TYPE_DATA_STORE_ENTITY = 'DATA_STORE_ENTITY'

A constant which can be used with the model_type property of a DataEntityDetails. This constant has a value of “DATA_STORE_ENTITY”

MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'

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

MODEL_TYPE_TABLE_ENTITY = 'TABLE_ENTITY'

A constant which can be used with the model_type property of a DataEntityDetails. This constant has a value of “TABLE_ENTITY”

MODEL_TYPE_VIEW_ENTITY = 'VIEW_ENTITY'

A constant which can be used with the model_type property of a DataEntityDetails. This constant has a value of “VIEW_ENTITY”

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

  • entity_type (str) – The value to assign to the entity_type property of this DataEntityFromFileEntityDetails. 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 DataEntityFromFileEntityDetails.

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

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

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

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

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

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

property data_format

Gets the data_format of this DataEntityFromFileEntityDetails.

Returns

The data_format of this DataEntityFromFileEntityDetails.

Return type

oci.data_integration.models.DataFormat

property description

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

Returns

The description of this DataEntityFromFileEntityDetails.

Return type

str

property entity_type

Gets the entity_type of this DataEntityFromFileEntityDetails. The entity type.

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

Returns

The entity_type of this DataEntityFromFileEntityDetails.

Return type

str

property external_key

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

Returns

The external_key of this DataEntityFromFileEntityDetails.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this DataEntityFromFileEntityDetails.

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

Return type

str

property key

Gets the key of this DataEntityFromFileEntityDetails. The object key.

Returns

The key of this DataEntityFromFileEntityDetails.

Return type

str

property model_type

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

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

Returns

The model_type of this DataEntityDetails.

Return type

str

property model_version

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

Returns

The model_version of this DataEntityFromFileEntityDetails.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this DataEntityFromFileEntityDetails.

Return type

int

property other_type_label

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

Returns

The other_type_label of this DataEntityFromFileEntityDetails.

Return type

str

property parent_ref

Gets the parent_ref of this DataEntityFromFileEntityDetails.

Returns

The parent_ref of this DataEntityFromFileEntityDetails.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this DataEntityFromFileEntityDetails. The resource name.

Returns

The resource_name of this DataEntityFromFileEntityDetails.

Return type

str

property shape

Gets the shape of this DataEntityFromFileEntityDetails.

Returns

The shape of this DataEntityFromFileEntityDetails.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DataEntityFromFileEntityDetails. The shape ID.

Returns

The shape_id of this DataEntityFromFileEntityDetails.

Return type

str

property types

Gets the types of this DataEntityFromFileEntityDetails.

Returns

The types of this DataEntityFromFileEntityDetails.

Return type

oci.data_integration.models.TypeLibrary

property unique_keys

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

Returns

The unique_keys of this DataEntityFromFileEntityDetails.

Return type

list[oci.data_integration.models.UniqueKey]