CreateEntityDetails¶

class oci.data_catalog.models.CreateEntityDetails(**kwargs)¶

Bases: object

Properties used in data entity create operations.

Attributes

`HARVEST_STATUS_COMPLETE`	A constant which can be used with the harvest_status property of a CreateEntityDetails.
`HARVEST_STATUS_DEFERRED`	A constant which can be used with the harvest_status property of a CreateEntityDetails.
`HARVEST_STATUS_ERROR`	A constant which can be used with the harvest_status property of a CreateEntityDetails.
`HARVEST_STATUS_IN_PROGRESS`	A constant which can be used with the harvest_status property of a CreateEntityDetails.
`business_name`	Gets the business_name of this CreateEntityDetails.
`custom_property_members`	Gets the custom_property_members of this CreateEntityDetails.
`description`	Gets the description of this CreateEntityDetails.
`display_name`	[Required] Gets the display_name of this CreateEntityDetails.
`folder_key`	Gets the folder_key of this CreateEntityDetails.
`harvest_status`	Gets the harvest_status of this CreateEntityDetails.
`is_logical`	Gets the is_logical of this CreateEntityDetails.
`is_partition`	Gets the is_partition of this CreateEntityDetails.
`last_job_key`	Gets the last_job_key of this CreateEntityDetails.
`pattern_key`	Gets the pattern_key of this CreateEntityDetails.
`properties`	Gets the properties of this CreateEntityDetails.
`realized_expression`	Gets the realized_expression of this CreateEntityDetails.
`time_external`	[Required] Gets the time_external of this CreateEntityDetails.
`type_key`	Gets the type_key of this CreateEntityDetails.

Methods

__init__(**kwargs) Initializes a new CreateEntityDetails object with values from keyword arguments.

HARVEST_STATUS_COMPLETE = 'COMPLETE'¶: A constant which can be used with the harvest_status property of a CreateEntityDetails. This constant has a value of “COMPLETE”

HARVEST_STATUS_DEFERRED = 'DEFERRED'¶: A constant which can be used with the harvest_status property of a CreateEntityDetails. This constant has a value of “DEFERRED”

HARVEST_STATUS_ERROR = 'ERROR'¶: A constant which can be used with the harvest_status property of a CreateEntityDetails. This constant has a value of “ERROR”

HARVEST_STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the harvest_status property of a CreateEntityDetails. This constant has a value of “IN_PROGRESS”

__init__(**kwargs)¶

Initializes a new CreateEntityDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateEntityDetails.
business_name (str) – The value to assign to the business_name property of this CreateEntityDetails.
type_key (str) – The value to assign to the type_key property of this CreateEntityDetails.
description (str) – The value to assign to the description property of this CreateEntityDetails.
time_external (datetime) – The value to assign to the time_external property of this CreateEntityDetails.
is_logical (bool) – The value to assign to the is_logical property of this CreateEntityDetails.
is_partition (bool) – The value to assign to the is_partition property of this CreateEntityDetails.
folder_key (str) – The value to assign to the folder_key property of this CreateEntityDetails.
pattern_key (str) – The value to assign to the pattern_key property of this CreateEntityDetails.
realized_expression (str) – The value to assign to the realized_expression property of this CreateEntityDetails.
harvest_status (str) – The value to assign to the harvest_status property of this CreateEntityDetails. Allowed values for this property are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED”
last_job_key (str) – The value to assign to the last_job_key property of this CreateEntityDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this CreateEntityDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateEntityDetails.

business_name¶

Gets the business_name of this CreateEntityDetails. Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.

Returns:	The business_name of this CreateEntityDetails.
Return type:	str

custom_property_members¶

Gets the custom_property_members of this CreateEntityDetails. The list of customized properties along with the values for this object

Returns:	The custom_property_members of this CreateEntityDetails.
Return type:	list[oci.data_catalog.models.CustomPropertySetUsage]

description¶

Gets the description of this CreateEntityDetails. Detailed description of a data entity.

Returns:	The description of this CreateEntityDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateEntityDetails. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CreateEntityDetails.
Return type:	str

folder_key¶

Gets the folder_key of this CreateEntityDetails. Key of the associated folder.

Returns:	The folder_key of this CreateEntityDetails.
Return type:	str

harvest_status¶

Gets the harvest_status of this CreateEntityDetails. Status of the object as updated by the harvest process. When an entity object is created , it’s harvest status will indicate if the entity’s metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.

Allowed values for this property are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED”

Returns:	The harvest_status of this CreateEntityDetails.
Return type:	str

is_logical¶

Gets the is_logical of this CreateEntityDetails. Property to indicate if the object is a physical materialized object or virtual. For example, View.

Returns:	The is_logical of this CreateEntityDetails.
Return type:	bool

is_partition¶

Gets the is_partition of this CreateEntityDetails. Property to indicate if the object is a sub object of a parent physical object.

Returns:	The is_partition of this CreateEntityDetails.
Return type:	bool

last_job_key¶

Gets the last_job_key of this CreateEntityDetails. Key of the last harvest process to update this object.

Returns:	The last_job_key of this CreateEntityDetails.
Return type:	str

pattern_key¶

Gets the pattern_key of this CreateEntityDetails. Key of the associated pattern if this is a logical entity.

Returns:	The pattern_key of this CreateEntityDetails.
Return type:	str

properties¶

Gets the properties of this CreateEntityDetails. A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most entities have required properties within the “default” category. To determine the set of required and optional properties for an entity type, a query can be done on ‘/types?type=dataEntity’ that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “key1”: “value1”}}}

Returns:	The properties of this CreateEntityDetails.
Return type:	dict(str, dict(str, str))

realized_expression¶

Gets the realized_expression of this CreateEntityDetails. The expression realized after resolving qualifiers . Used in deriving this logical entity

Returns:	The realized_expression of this CreateEntityDetails.
Return type:	str

time_external¶

[Required] Gets the time_external of this CreateEntityDetails. Last modified timestamp of the object in the external system.

Returns:	The time_external of this CreateEntityDetails.
Return type:	datetime

type_key¶

Gets the type_key of this CreateEntityDetails. The type of data entity object. Type key’s can be found via the ‘/types’ endpoint.

Returns:	The type_key of this CreateEntityDetails.
Return type:	str