EntityShapeFromDataStore

class oci.data_connectivity.models.EntityShapeFromDataStore(**kwargs)

Bases: oci.data_connectivity.models.entity_shape.EntityShape

The data store entity details.

Attributes

ENTITY_TYPE_DATA_STORE A constant which can be used with the entity_type property of a EntityShapeFromDataStore.
ENTITY_TYPE_FILE A constant which can be used with the entity_type property of a EntityShapeFromDataStore.
ENTITY_TYPE_SQL A constant which can be used with the entity_type property of a EntityShapeFromDataStore.
ENTITY_TYPE_TABLE A constant which can be used with the entity_type property of a EntityShapeFromDataStore.
ENTITY_TYPE_VIEW A constant which can be used with the entity_type property of a EntityShapeFromDataStore.
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
data_format Gets the data_format of this EntityShapeFromDataStore.
description Gets the description of this EntityShapeFromDataStore.
entity_type Gets the entity_type of this EntityShapeFromDataStore.
external_key Gets the external_key of this EntityShapeFromDataStore.
foreign_keys Gets the foreign_keys of this EntityShapeFromDataStore.
identifier Gets the identifier of this EntityShapeFromDataStore.
key Gets the key of this EntityShapeFromDataStore.
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 EntityShapeFromDataStore.
name Gets the name of this EntityShapeFromDataStore.
object_status Gets the object_status of this EntityShapeFromDataStore.
object_version Gets the object_version of this EntityShapeFromDataStore.
other_type_label Gets the other_type_label of this EntityShapeFromDataStore.
parent_ref Gets the parent_ref of this EntityShapeFromDataStore.
resource_name Gets the resource_name of this EntityShapeFromDataStore.
shape Gets the shape of this EntityShapeFromDataStore.
shape_id Gets the shape_id of this EntityShapeFromDataStore.
unique_keys Gets the unique_keys of this EntityShapeFromDataStore.

Methods

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

ENTITY_TYPE_SQL = 'SQL'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

A constant which can be used with the entity_type property of a EntityShapeFromDataStore. 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 EntityShapeFromDataStore 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 EntityShapeFromDataStore. 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_connectivity.models.ObjectMetadata) – The value to assign to the metadata property of this EntityShapeFromDataStore.
  • key (str) – The value to assign to the key property of this EntityShapeFromDataStore.
  • model_version (str) – The value to assign to the model_version property of this EntityShapeFromDataStore.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this EntityShapeFromDataStore.
  • name (str) – The value to assign to the name property of this EntityShapeFromDataStore.
  • description (str) – The value to assign to the description property of this EntityShapeFromDataStore.
  • object_version (int) – The value to assign to the object_version property of this EntityShapeFromDataStore.
  • external_key (str) – The value to assign to the external_key property of this EntityShapeFromDataStore.
  • shape (oci.data_connectivity.models.Shape) – The value to assign to the shape property of this EntityShapeFromDataStore.
  • shape_id (str) – The value to assign to the shape_id property of this EntityShapeFromDataStore.
  • entity_type (str) – The value to assign to the entity_type property of this EntityShapeFromDataStore. Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”, “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 EntityShapeFromDataStore.
  • unique_keys (list[oci.data_connectivity.models.UniqueKey]) – The value to assign to the unique_keys property of this EntityShapeFromDataStore.
  • foreign_keys (list[oci.data_connectivity.models.ForeignKey]) – The value to assign to the foreign_keys property of this EntityShapeFromDataStore.
  • resource_name (str) – The value to assign to the resource_name property of this EntityShapeFromDataStore.
  • data_format (oci.data_connectivity.models.DataFormat) – The value to assign to the data_format property of this EntityShapeFromDataStore.
  • object_status (int) – The value to assign to the object_status property of this EntityShapeFromDataStore.
  • identifier (str) – The value to assign to the identifier property of this EntityShapeFromDataStore.
data_format

Gets the data_format of this EntityShapeFromDataStore.

Returns:The data_format of this EntityShapeFromDataStore.
Return type:oci.data_connectivity.models.DataFormat
description

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

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

Gets the entity_type of this EntityShapeFromDataStore. The entity type.

Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”, “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 EntityShapeFromDataStore.
Return type:str
external_key

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

Returns:The external_key of this EntityShapeFromDataStore.
Return type:str
foreign_keys

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

Returns:The foreign_keys of this EntityShapeFromDataStore.
Return type:list[oci.data_connectivity.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 EntityShapeFromDataStore. 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 EntityShapeFromDataStore.
Return type:str
key

Gets the key of this EntityShapeFromDataStore. The object key.

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

Gets the metadata of this EntityShape.

Returns:The metadata of this EntityShape.
Return type:oci.data_connectivity.models.ObjectMetadata
model_type

[Required] Gets the model_type of this EntityShape. 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 EntityShape.
Return type:str
model_version

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

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

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

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

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

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

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

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

Gets the parent_ref of this EntityShapeFromDataStore.

Returns:The parent_ref of this EntityShapeFromDataStore.
Return type:oci.data_connectivity.models.ParentReference
resource_name

Gets the resource_name of this EntityShapeFromDataStore. The resource name.

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

Gets the shape of this EntityShapeFromDataStore.

Returns:The shape of this EntityShapeFromDataStore.
Return type:oci.data_connectivity.models.Shape
shape_id

Gets the shape_id of this EntityShapeFromDataStore. The shape ID.

Returns:The shape_id of this EntityShapeFromDataStore.
Return type:str
unique_keys

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

Returns:The unique_keys of this EntityShapeFromDataStore.
Return type:list[oci.data_connectivity.models.UniqueKey]