DerivedEntity

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

Bases: DataEntity

The Derive entity object

Attributes:

MODEL_TYPE_DATA_STORE_ENTITY

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

MODEL_TYPE_DERIVED_ENTITY

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

MODEL_TYPE_FILE_ENTITY

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

MODEL_TYPE_OBJECT_ENTITY

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

MODEL_TYPE_SQL_ENTITY

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

MODEL_TYPE_TABLE_ENTITY

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

MODEL_TYPE_VIEW_ENTITY

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

MODE_IN

A constant which can be used with the mode property of a DerivedEntity.

MODE_OUT

A constant which can be used with the mode property of a DerivedEntity.

derived_properties

Gets the derived_properties of this DerivedEntity.

identifier

Gets the identifier of this DerivedEntity.

key

Gets the key of this DerivedEntity.

metadata

Gets the metadata of this DataEntity.

mode

Gets the mode of this DerivedEntity.

model_type

[Required] Gets the model_type of this DataEntity.

model_version

Gets the model_version of this DerivedEntity.

name

Gets the name of this DerivedEntity.

object_status

Gets the object_status of this DerivedEntity.

object_version

Gets the object_version of this DerivedEntity.

parent_ref

Gets the parent_ref of this DerivedEntity.

ref_data_object

Gets the ref_data_object of this DerivedEntity.

resource_name

Gets the resource_name of this DerivedEntity.

shape

Gets the shape of this DerivedEntity.

shape_id

Gets the shape_id of this DerivedEntity.

Methods:

__init__(**kwargs)

Initializes a new DerivedEntity 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.

MODEL_TYPE_DATA_STORE_ENTITY = 'DATA_STORE_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “DATA_STORE_ENTITY”

MODEL_TYPE_DERIVED_ENTITY = 'DERIVED_ENTITY'

A constant which can be used with the model_type property of a DataEntity. This constant has a value of “DERIVED_ENTITY”

MODEL_TYPE_FILE_ENTITY = 'FILE_ENTITY'

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

MODE_IN = 'IN'

A constant which can be used with the mode property of a DerivedEntity. This constant has a value of “IN”

MODE_OUT = 'OUT'

A constant which can be used with the mode property of a DerivedEntity. This constant has a value of “OUT”

__init__(**kwargs)

Initializes a new DerivedEntity object with values from keyword arguments. The default value of the model_type attribute of this class is DERIVED_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 DerivedEntity. Allowed values for this property are: “VIEW_ENTITY”, “TABLE_ENTITY”, “FILE_ENTITY”, “SQL_ENTITY”, “OBJECT_ENTITY”, “DATA_STORE_ENTITY”, “DERIVED_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 DerivedEntity.

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

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

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

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

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

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

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

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

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

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

  • ref_data_object (oci.data_integration.models.ReferencedDataObject) – The value to assign to the ref_data_object property of this DerivedEntity.

  • mode (str) – The value to assign to the mode property of this DerivedEntity. Allowed values for this property are: “IN”, “OUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • derived_properties (dict(str, object)) – The value to assign to the derived_properties property of this DerivedEntity.

property derived_properties

Gets the derived_properties of this DerivedEntity. Property-bag (key-value pairs where key is Shape Field resource name and value is object)

Returns

The derived_properties of this DerivedEntity.

Return type

dict(str, object)

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

Return type

str

property key

Gets the key of this DerivedEntity. The object key.

Returns

The key of this DerivedEntity.

Return type

str

property metadata

Gets the metadata of this DataEntity.

Returns

The metadata of this DataEntity.

Return type

oci.data_integration.models.ObjectMetadata

property mode

Gets the mode of this DerivedEntity. Determines whether entity is treated as source or target

Allowed values for this property are: “IN”, “OUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The mode of this DerivedEntity.

Return type

str

property 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”, “OBJECT_ENTITY”, “DATA_STORE_ENTITY”, “DERIVED_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

property model_version

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

Returns

The model_version of this DerivedEntity.

Return type

str

property name

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

Return type

str

property object_status

Gets the object_status of this DerivedEntity. The status of an object that can be set to value 1 for shallow reference across objects, other values reserved.

Returns

The object_status of this DerivedEntity.

Return type

int

property object_version

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

Returns

The object_version of this DerivedEntity.

Return type

int

property parent_ref

Gets the parent_ref of this DerivedEntity.

Returns

The parent_ref of this DerivedEntity.

Return type

oci.data_integration.models.ParentReference

property ref_data_object

Gets the ref_data_object of this DerivedEntity.

Returns

The ref_data_object of this DerivedEntity.

Return type

oci.data_integration.models.ReferencedDataObject

property resource_name

Gets the resource_name of this DerivedEntity. The resource name.

Returns

The resource_name of this DerivedEntity.

Return type

str

property shape

Gets the shape of this DerivedEntity.

Returns

The shape of this DerivedEntity.

Return type

oci.data_integration.models.Shape

property shape_id

Gets the shape_id of this DerivedEntity. The shape ID.

Returns

The shape_id of this DerivedEntity.

Return type

str