DataEntityFromDataStoreEntityDetails

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

Bases: DataEntityDetails

The view entity data entity details.

Attributes:

ENTITY_TYPE_DATA_STORE

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

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OTHER

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

ENTITY_TYPE_QUEUE

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

ENTITY_TYPE_STREAM

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

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.

description

Gets the description of this DataEntityFromDataStoreEntityDetails.

entity_type

Gets the entity_type of this DataEntityFromDataStoreEntityDetails.

external_key

Gets the external_key of this DataEntityFromDataStoreEntityDetails.

filters

Gets the filters of this DataEntityFromDataStoreEntityDetails.

foreign_keys

Gets the foreign_keys of this DataEntityFromDataStoreEntityDetails.

identifier

Gets the identifier of this DataEntityFromDataStoreEntityDetails.

is_effective_date_disabled

Gets the is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails.

is_flex_data_store

Gets the is_flex_data_store of this DataEntityFromDataStoreEntityDetails.

is_silent_error

Gets the is_silent_error of this DataEntityFromDataStoreEntityDetails.

key

Gets the key of this DataEntityFromDataStoreEntityDetails.

model_type

[Required] Gets the model_type of this DataEntityDetails.

model_version

Gets the model_version of this DataEntityFromDataStoreEntityDetails.

name

Gets the name of this DataEntityFromDataStoreEntityDetails.

object_status

Gets the object_status of this DataEntityFromDataStoreEntityDetails.

object_version

Gets the object_version of this DataEntityFromDataStoreEntityDetails.

other_type_label

Gets the other_type_label of this DataEntityFromDataStoreEntityDetails.

parent_ref

Gets the parent_ref of this DataEntityFromDataStoreEntityDetails.

resource_name

Gets the resource_name of this DataEntityFromDataStoreEntityDetails.

shape

Gets the shape of this DataEntityFromDataStoreEntityDetails.

shape_id

Gets the shape_id of this DataEntityFromDataStoreEntityDetails.

supports_incremental

Gets the supports_incremental of this DataEntityFromDataStoreEntityDetails.

types

Gets the types of this DataEntityFromDataStoreEntityDetails.

unique_keys

Gets the unique_keys of this DataEntityFromDataStoreEntityDetails.

Methods:

__init__(**kwargs)

Initializes a new DataEntityFromDataStoreEntityDetails 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_DATA_STORE = 'DATA_STORE'

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

ENTITY_TYPE_FILE = 'FILE'

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

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a DataEntityFromDataStoreEntityDetails. 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 DataEntityFromDataStoreEntityDetails object with values from keyword arguments. The default value of the model_type attribute of this class is DATA_STORE_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 DataEntityFromDataStoreEntityDetails. 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 DataEntityFromDataStoreEntityDetails.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • filters (str) – The value to assign to the filters property of this DataEntityFromDataStoreEntityDetails.

  • is_effective_date_disabled (bool) – The value to assign to the is_effective_date_disabled property of this DataEntityFromDataStoreEntityDetails.

  • is_flex_data_store (bool) – The value to assign to the is_flex_data_store property of this DataEntityFromDataStoreEntityDetails.

  • is_silent_error (bool) – The value to assign to the is_silent_error property of this DataEntityFromDataStoreEntityDetails.

  • supports_incremental (bool) – The value to assign to the supports_incremental property of this DataEntityFromDataStoreEntityDetails.

property description

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

Returns

The description of this DataEntityFromDataStoreEntityDetails.

Return type

str

property entity_type

Gets the entity_type of this DataEntityFromDataStoreEntityDetails. The entity type.

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

Returns

The entity_type of this DataEntityFromDataStoreEntityDetails.

Return type

str

property external_key

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

Returns

The external_key of this DataEntityFromDataStoreEntityDetails.

Return type

str

property filters

Gets the filters of this DataEntityFromDataStoreEntityDetails. Filters present in the Datastore. It can be Null.

Returns

The filters of this DataEntityFromDataStoreEntityDetails.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this DataEntityFromDataStoreEntityDetails.

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

Return type

str

property is_effective_date_disabled

Gets the is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails. It shows whether or not effective date is disabled

Returns

The is_effective_date_disabled of this DataEntityFromDataStoreEntityDetails.

Return type

bool

property is_flex_data_store

Gets the is_flex_data_store of this DataEntityFromDataStoreEntityDetails. It shows whether the datastore is of flex type

Returns

The is_flex_data_store of this DataEntityFromDataStoreEntityDetails.

Return type

bool

property is_silent_error

Gets the is_silent_error of this DataEntityFromDataStoreEntityDetails. It shows whether the extraction of this datastore will stop on error

Returns

The is_silent_error of this DataEntityFromDataStoreEntityDetails.

Return type

bool

property key

Gets the key of this DataEntityFromDataStoreEntityDetails. The object key.

Returns

The key of this DataEntityFromDataStoreEntityDetails.

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

Returns

The model_version of this DataEntityFromDataStoreEntityDetails.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this DataEntityFromDataStoreEntityDetails.

Return type

int

property other_type_label

Gets the other_type_label of this DataEntityFromDataStoreEntityDetails. Specifies other type labels.

Returns

The other_type_label of this DataEntityFromDataStoreEntityDetails.

Return type

str

property parent_ref

Gets the parent_ref of this DataEntityFromDataStoreEntityDetails.

Returns

The parent_ref of this DataEntityFromDataStoreEntityDetails.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this DataEntityFromDataStoreEntityDetails. The resource name.

Returns

The resource_name of this DataEntityFromDataStoreEntityDetails.

Return type

str

property shape

Gets the shape of this DataEntityFromDataStoreEntityDetails.

Returns

The shape of this DataEntityFromDataStoreEntityDetails.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DataEntityFromDataStoreEntityDetails. The shape ID.

Returns

The shape_id of this DataEntityFromDataStoreEntityDetails.

Return type

str

property supports_incremental

Gets the supports_incremental of this DataEntityFromDataStoreEntityDetails. It shows whether the datastore supports Incremental Extract or not.

Returns

The supports_incremental of this DataEntityFromDataStoreEntityDetails.

Return type

bool

property types

Gets the types of this DataEntityFromDataStoreEntityDetails.

Returns

The types of this DataEntityFromDataStoreEntityDetails.

Return type

oci.data_integration.models.TypeLibrary

property unique_keys

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

Returns

The unique_keys of this DataEntityFromDataStoreEntityDetails.

Return type

list[oci.data_integration.models.UniqueKey]