DataEntityFromDataStore

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

Bases: oci.data_integration.models.data_entity.DataEntity

The view entity data entity details.

Attributes

ENTITY_TYPE_DATA_STORE A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_FILE A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_OTHER A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_QUEUE A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_STREAM A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_TABLE A constant which can be used with the entity_type property of a DataEntityFromDataStore.
ENTITY_TYPE_VIEW A constant which can be used with the entity_type property of a DataEntityFromDataStore.
MODEL_TYPE_DATA_STORE_ENTITY str(object=’’) -> str
MODEL_TYPE_FILE_ENTITY str(object=’’) -> str
MODEL_TYPE_SQL_ENTITY str(object=’’) -> str
MODEL_TYPE_TABLE_ENTITY str(object=’’) -> str
MODEL_TYPE_VIEW_ENTITY str(object=’’) -> str
description Gets the description of this DataEntityFromDataStore.
entity_type Gets the entity_type of this DataEntityFromDataStore.
external_key Gets the external_key of this DataEntityFromDataStore.
filters Gets the filters of this DataEntityFromDataStore.
foreign_keys Gets the foreign_keys of this DataEntityFromDataStore.
identifier Gets the identifier of this DataEntityFromDataStore.
is_effective_date_disabled Gets the is_effective_date_disabled of this DataEntityFromDataStore.
is_flex_data_store Gets the is_flex_data_store of this DataEntityFromDataStore.
is_silent_error Gets the is_silent_error of this DataEntityFromDataStore.
key Gets the key of this DataEntityFromDataStore.
metadata Gets the metadata of this DataEntity.
model_type [Required] Gets the model_type of this DataEntity.
model_version Gets the model_version of this DataEntityFromDataStore.
name Gets the name of this DataEntityFromDataStore.
object_status Gets the object_status of this DataEntityFromDataStore.
object_version Gets the object_version of this DataEntityFromDataStore.
other_type_label Gets the other_type_label of this DataEntityFromDataStore.
parent_ref Gets the parent_ref of this DataEntityFromDataStore.
resource_name Gets the resource_name of this DataEntityFromDataStore.
shape Gets the shape of this DataEntityFromDataStore.
shape_id Gets the shape_id of this DataEntityFromDataStore.
supports_incremental Gets the supports_incremental of this DataEntityFromDataStore.
types Gets the types of this DataEntityFromDataStore.
unique_keys Gets the unique_keys of this DataEntityFromDataStore.

Methods

__init__(**kwargs) Initializes a new DataEntityFromDataStore 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 DataEntityFromDataStore. 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 DataEntityFromDataStore. This constant has a value of “FILE”

ENTITY_TYPE_OTHER = 'OTHER'

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

ENTITY_TYPE_QUEUE = 'QUEUE'

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

ENTITY_TYPE_STREAM = 'STREAM'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

MODEL_TYPE_DATA_STORE_ENTITY = 'DATA_STORE_ENTITY'
MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'
MODEL_TYPE_SQL_ENTITY = 'SQL_ENTITY'
MODEL_TYPE_TABLE_ENTITY = 'TABLE_ENTITY'
MODEL_TYPE_VIEW_ENTITY = 'VIEW_ENTITY'
__init__(**kwargs)

Initializes a new DataEntityFromDataStore 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 DataEntityFromDataStore. Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_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 DataEntityFromDataStore.
  • key (str) – The value to assign to the key property of this DataEntityFromDataStore.
  • model_version (str) – The value to assign to the model_version property of this DataEntityFromDataStore.
  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this DataEntityFromDataStore.
  • name (str) – The value to assign to the name property of this DataEntityFromDataStore.
  • description (str) – The value to assign to the description property of this DataEntityFromDataStore.
  • object_version (int) – The value to assign to the object_version property of this DataEntityFromDataStore.
  • external_key (str) – The value to assign to the external_key property of this DataEntityFromDataStore.
  • shape (oci.data_integration.models.Shape) – The value to assign to the shape property of this DataEntityFromDataStore.
  • shape_id (str) – The value to assign to the shape_id property of this DataEntityFromDataStore.
  • types (oci.data_integration.models.TypeLibrary) – The value to assign to the types property of this DataEntityFromDataStore.
  • entity_type (str) – The value to assign to the entity_type property of this DataEntityFromDataStore. 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 DataEntityFromDataStore.
  • unique_keys (list[oci.data_integration.models.UniqueKey]) – The value to assign to the unique_keys property of this DataEntityFromDataStore.
  • foreign_keys (list[oci.data_integration.models.ForeignKey]) – The value to assign to the foreign_keys property of this DataEntityFromDataStore.
  • resource_name (str) – The value to assign to the resource_name property of this DataEntityFromDataStore.
  • object_status (int) – The value to assign to the object_status property of this DataEntityFromDataStore.
  • identifier (str) – The value to assign to the identifier property of this DataEntityFromDataStore.
  • filters (str) – The value to assign to the filters property of this DataEntityFromDataStore.
  • is_effective_date_disabled (bool) – The value to assign to the is_effective_date_disabled property of this DataEntityFromDataStore.
  • is_flex_data_store (bool) – The value to assign to the is_flex_data_store property of this DataEntityFromDataStore.
  • is_silent_error (bool) – The value to assign to the is_silent_error property of this DataEntityFromDataStore.
  • supports_incremental (bool) – The value to assign to the supports_incremental property of this DataEntityFromDataStore.
description

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

Returns:The description of this DataEntityFromDataStore.
Return type:str
entity_type

Gets the entity_type of this DataEntityFromDataStore. 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 DataEntityFromDataStore.
Return type:str
external_key

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

Returns:The external_key of this DataEntityFromDataStore.
Return type:str
filters

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

Returns:The filters of this DataEntityFromDataStore.
Return type:str
foreign_keys

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

Returns:The foreign_keys of this DataEntityFromDataStore.
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.

identifier

Gets the identifier of this DataEntityFromDataStore. 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 DataEntityFromDataStore.
Return type:str
is_effective_date_disabled

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

Returns:The is_effective_date_disabled of this DataEntityFromDataStore.
Return type:bool
is_flex_data_store

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

Returns:The is_flex_data_store of this DataEntityFromDataStore.
Return type:bool
is_silent_error

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

Returns:The is_silent_error of this DataEntityFromDataStore.
Return type:bool
key

Gets the key of this DataEntityFromDataStore. The object key.

Returns:The key of this DataEntityFromDataStore.
Return type:str
metadata

Gets the metadata of this DataEntity.

Returns:The metadata of this DataEntity.
Return type:oci.data_integration.models.ObjectMetadata
model_type

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

Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_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 DataEntity.
Return type:str
model_version

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

Returns:The model_version of this DataEntityFromDataStore.
Return type:str
name

Gets the name of this DataEntityFromDataStore. 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 DataEntityFromDataStore.
Return type:str
object_status

Gets the object_status of this DataEntityFromDataStore. 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 DataEntityFromDataStore.
Return type:int
object_version

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

Returns:The object_version of this DataEntityFromDataStore.
Return type:int
other_type_label

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

Returns:The other_type_label of this DataEntityFromDataStore.
Return type:str
parent_ref

Gets the parent_ref of this DataEntityFromDataStore.

Returns:The parent_ref of this DataEntityFromDataStore.
Return type:oci.data_integration.models.ParentReference
resource_name

Gets the resource_name of this DataEntityFromDataStore. The resource name.

Returns:The resource_name of this DataEntityFromDataStore.
Return type:str
shape

Gets the shape of this DataEntityFromDataStore.

Returns:The shape of this DataEntityFromDataStore.
Return type:oci.data_integration.models.Shape
shape_id

Gets the shape_id of this DataEntityFromDataStore. The shape ID.

Returns:The shape_id of this DataEntityFromDataStore.
Return type:str
supports_incremental

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

Returns:The supports_incremental of this DataEntityFromDataStore.
Return type:bool
types

Gets the types of this DataEntityFromDataStore.

Returns:The types of this DataEntityFromDataStore.
Return type:oci.data_integration.models.TypeLibrary
unique_keys

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

Returns:The unique_keys of this DataEntityFromDataStore.
Return type:list[oci.data_integration.models.UniqueKey]