CreateEntityShapeDetails

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

Bases: object

The data entity shape object.

Attributes

ENTITY_TYPE_FILE A constant which can be used with the entity_type property of a CreateEntityShapeDetails.
ENTITY_TYPE_SQL A constant which can be used with the entity_type property of a CreateEntityShapeDetails.
ENTITY_TYPE_TABLE A constant which can be used with the entity_type property of a CreateEntityShapeDetails.
ENTITY_TYPE_VIEW A constant which can be used with the entity_type property of a CreateEntityShapeDetails.
MODEL_TYPE_DATA_STORE_ENTITY A constant which can be used with the model_type property of a CreateEntityShapeDetails.
MODEL_TYPE_FILE_ENTITY A constant which can be used with the model_type property of a CreateEntityShapeDetails.
MODEL_TYPE_SQL_ENTITY A constant which can be used with the model_type property of a CreateEntityShapeDetails.
MODEL_TYPE_TABLE_ENTITY A constant which can be used with the model_type property of a CreateEntityShapeDetails.
MODEL_TYPE_VIEW_ENTITY A constant which can be used with the model_type property of a CreateEntityShapeDetails.
entity_properties Gets the entity_properties of this CreateEntityShapeDetails.
entity_type Gets the entity_type of this CreateEntityShapeDetails.
external_key Gets the external_key of this CreateEntityShapeDetails.
foreign_keys Gets the foreign_keys of this CreateEntityShapeDetails.
identifier Gets the identifier of this CreateEntityShapeDetails.
key Gets the key of this CreateEntityShapeDetails.
model_type [Required] Gets the model_type of this CreateEntityShapeDetails.
model_version Gets the model_version of this CreateEntityShapeDetails.
name [Required] Gets the name of this CreateEntityShapeDetails.
object_status Gets the object_status of this CreateEntityShapeDetails.
object_version Gets the object_version of this CreateEntityShapeDetails.
other_type_label Gets the other_type_label of this CreateEntityShapeDetails.
parent_ref Gets the parent_ref of this CreateEntityShapeDetails.
resource_name Gets the resource_name of this CreateEntityShapeDetails.
shape Gets the shape of this CreateEntityShapeDetails.
shape_id Gets the shape_id of this CreateEntityShapeDetails.
types Gets the types of this CreateEntityShapeDetails.
unique_keys Gets the unique_keys of this CreateEntityShapeDetails.

Methods

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

ENTITY_TYPE_SQL = 'SQL'

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

ENTITY_TYPE_TABLE = 'TABLE'

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

ENTITY_TYPE_VIEW = 'VIEW'

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

MODEL_TYPE_SQL_ENTITY = 'SQL_ENTITY'

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

__init__(**kwargs)

Initializes a new CreateEntityShapeDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 CreateEntityShapeDetails. Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “DATA_STORE_ENTITY”, “SQL_ENTITY”
  • key (str) – The value to assign to the key property of this CreateEntityShapeDetails.
  • model_version (str) – The value to assign to the model_version property of this CreateEntityShapeDetails.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this CreateEntityShapeDetails.
  • name (str) – The value to assign to the name property of this CreateEntityShapeDetails.
  • object_version (int) – The value to assign to the object_version property of this CreateEntityShapeDetails.
  • external_key (str) – The value to assign to the external_key property of this CreateEntityShapeDetails.
  • shape (oci.data_connectivity.models.Shape) – The value to assign to the shape property of this CreateEntityShapeDetails.
  • shape_id (str) – The value to assign to the shape_id property of this CreateEntityShapeDetails.
  • entity_type (str) – The value to assign to the entity_type property of this CreateEntityShapeDetails. Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”
  • other_type_label (str) – The value to assign to the other_type_label property of this CreateEntityShapeDetails.
  • unique_keys (list[oci.data_connectivity.models.UniqueKey]) – The value to assign to the unique_keys property of this CreateEntityShapeDetails.
  • foreign_keys (list[oci.data_connectivity.models.ForeignKey]) – The value to assign to the foreign_keys property of this CreateEntityShapeDetails.
  • resource_name (str) – The value to assign to the resource_name property of this CreateEntityShapeDetails.
  • object_status (int) – The value to assign to the object_status property of this CreateEntityShapeDetails.
  • identifier (str) – The value to assign to the identifier property of this CreateEntityShapeDetails.
  • types (oci.data_connectivity.models.TypeLibrary) – The value to assign to the types property of this CreateEntityShapeDetails.
  • entity_properties (dict(str, str)) – The value to assign to the entity_properties property of this CreateEntityShapeDetails.
entity_properties

Gets the entity_properties of this CreateEntityShapeDetails. Map<String, String> for entity properties

Returns:The entity_properties of this CreateEntityShapeDetails.
Return type:dict(str, str)
entity_type

Gets the entity_type of this CreateEntityShapeDetails. The entity type.

Allowed values for this property are: “TABLE”, “VIEW”, “FILE”, “SQL”

Returns:The entity_type of this CreateEntityShapeDetails.
Return type:str
external_key

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

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

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

Returns:The foreign_keys of this CreateEntityShapeDetails.
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 CreateEntityShapeDetails. 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 CreateEntityShapeDetails.
Return type:str
key

Gets the key of this CreateEntityShapeDetails. The object key.

Returns:The key of this CreateEntityShapeDetails.
Return type:str
model_type

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

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

Returns:The model_type of this CreateEntityShapeDetails.
Return type:str
model_version

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

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

[Required] Gets the name of this CreateEntityShapeDetails. 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 CreateEntityShapeDetails.
Return type:str
object_status

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

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

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

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

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

Gets the parent_ref of this CreateEntityShapeDetails.

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

Gets the resource_name of this CreateEntityShapeDetails. The resource name.

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

Gets the shape of this CreateEntityShapeDetails.

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

Gets the shape_id of this CreateEntityShapeDetails. The shape ID.

Returns:The shape_id of this CreateEntityShapeDetails.
Return type:str
types

Gets the types of this CreateEntityShapeDetails.

Returns:The types of this CreateEntityShapeDetails.
Return type:oci.data_connectivity.models.TypeLibrary
unique_keys

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

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