DataEntitySummaryFromDataStore

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

Bases: DataEntitySummary

The view entity data entity details.

Attributes:

ENTITY_TYPE_DATA_STORE

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

ENTITY_TYPE_FILE

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

ENTITY_TYPE_OTHER

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

ENTITY_TYPE_QUEUE

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

ENTITY_TYPE_STREAM

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

ENTITY_TYPE_TABLE

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

ENTITY_TYPE_VIEW

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

MODEL_TYPE_DATA_STORE_ENTITY

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

MODEL_TYPE_FILE_ENTITY

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

MODEL_TYPE_OBJECT_ENTITY

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

MODEL_TYPE_SQL_ENTITY

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

MODEL_TYPE_TABLE_ENTITY

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

MODEL_TYPE_VIEW_ENTITY

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

description

Gets the description of this DataEntitySummaryFromDataStore.

entity_type

Gets the entity_type of this DataEntitySummaryFromDataStore.

external_key

Gets the external_key of this DataEntitySummaryFromDataStore.

filters

Gets the filters of this DataEntitySummaryFromDataStore.

foreign_keys

Gets the foreign_keys of this DataEntitySummaryFromDataStore.

identifier

Gets the identifier of this DataEntitySummaryFromDataStore.

is_effective_date_disabled

Gets the is_effective_date_disabled of this DataEntitySummaryFromDataStore.

is_flex_data_store

Gets the is_flex_data_store of this DataEntitySummaryFromDataStore.

is_silent_error

Gets the is_silent_error of this DataEntitySummaryFromDataStore.

key

Gets the key of this DataEntitySummaryFromDataStore.

metadata

Gets the metadata of this DataEntitySummary.

model_type

[Required] Gets the model_type of this DataEntitySummary.

model_version

Gets the model_version of this DataEntitySummaryFromDataStore.

name

Gets the name of this DataEntitySummaryFromDataStore.

object_status

Gets the object_status of this DataEntitySummaryFromDataStore.

object_version

Gets the object_version of this DataEntitySummaryFromDataStore.

other_type_label

Gets the other_type_label of this DataEntitySummaryFromDataStore.

parent_ref

Gets the parent_ref of this DataEntitySummaryFromDataStore.

resource_name

Gets the resource_name of this DataEntitySummaryFromDataStore.

shape

Gets the shape of this DataEntitySummaryFromDataStore.

shape_id

Gets the shape_id of this DataEntitySummaryFromDataStore.

supports_incremental

Gets the supports_incremental of this DataEntitySummaryFromDataStore.

types

Gets the types of this DataEntitySummaryFromDataStore.

unique_keys

Gets the unique_keys of this DataEntitySummaryFromDataStore.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property description

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

Returns

The description of this DataEntitySummaryFromDataStore.

Return type

str

property entity_type

Gets the entity_type of this DataEntitySummaryFromDataStore. The entity type.

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

Returns

The entity_type of this DataEntitySummaryFromDataStore.

Return type

str

property external_key

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

Returns

The external_key of this DataEntitySummaryFromDataStore.

Return type

str

property filters

Gets the filters of this DataEntitySummaryFromDataStore. Query filter for the extract. It can be Null.

Returns

The filters of this DataEntitySummaryFromDataStore.

Return type

str

property foreign_keys

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

Returns

The foreign_keys of this DataEntitySummaryFromDataStore.

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

Return type

str

property is_effective_date_disabled

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

Returns

The is_effective_date_disabled of this DataEntitySummaryFromDataStore.

Return type

bool

property is_flex_data_store

Gets the is_flex_data_store of this DataEntitySummaryFromDataStore. Is Flex data store. Metadata csv will be generated for flex data store

Returns

The is_flex_data_store of this DataEntitySummaryFromDataStore.

Return type

bool

property is_silent_error

Gets the is_silent_error of this DataEntitySummaryFromDataStore. Should the VO failure fail the whole batch?

Returns

The is_silent_error of this DataEntitySummaryFromDataStore.

Return type

bool

property key

Gets the key of this DataEntitySummaryFromDataStore. The object key.

Returns

The key of this DataEntitySummaryFromDataStore.

Return type

str

property metadata

Gets the metadata of this DataEntitySummary.

Returns

The metadata of this DataEntitySummary.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

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

Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”, “DATA_STORE_ENTITY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this DataEntitySummary.

Return type

str

property model_version

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

Returns

The model_version of this DataEntitySummaryFromDataStore.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this DataEntitySummaryFromDataStore.

Return type

int

property other_type_label

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

Returns

The other_type_label of this DataEntitySummaryFromDataStore.

Return type

str

property parent_ref

Gets the parent_ref of this DataEntitySummaryFromDataStore.

Returns

The parent_ref of this DataEntitySummaryFromDataStore.

Return type

oci.data_integration.models.ParentReference

property resource_name

Gets the resource_name of this DataEntitySummaryFromDataStore. The resource name.

Returns

The resource_name of this DataEntitySummaryFromDataStore.

Return type

str

property shape

Gets the shape of this DataEntitySummaryFromDataStore.

Returns

The shape of this DataEntitySummaryFromDataStore.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DataEntitySummaryFromDataStore. The shape ID.

Returns

The shape_id of this DataEntitySummaryFromDataStore.

Return type

str

property supports_incremental

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

Returns

The supports_incremental of this DataEntitySummaryFromDataStore.

Return type

bool

property types

Gets the types of this DataEntitySummaryFromDataStore.

Returns

The types of this DataEntitySummaryFromDataStore.

Return type

oci.data_integration.models.TypeLibrary

property unique_keys

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

Returns

The unique_keys of this DataEntitySummaryFromDataStore.

Return type

list[oci.data_integration.models.UniqueKey]