UpdateEntityDetails¶
- class oci.data_catalog.models.UpdateEntityDetails(**kwargs)¶
Bases:
objectProperties used in entity update operations.
Attributes:
A constant which can be used with the harvest_status property of a UpdateEntityDetails.
A constant which can be used with the harvest_status property of a UpdateEntityDetails.
A constant which can be used with the harvest_status property of a UpdateEntityDetails.
A constant which can be used with the harvest_status property of a UpdateEntityDetails.
Gets the business_name of this UpdateEntityDetails.
Gets the custom_property_members of this UpdateEntityDetails.
Gets the description of this UpdateEntityDetails.
Gets the display_name of this UpdateEntityDetails.
Gets the folder_key of this UpdateEntityDetails.
Gets the harvest_status of this UpdateEntityDetails.
Gets the is_logical of this UpdateEntityDetails.
Gets the is_partition of this UpdateEntityDetails.
Gets the last_job_key of this UpdateEntityDetails.
Gets the pattern_key of this UpdateEntityDetails.
Gets the properties of this UpdateEntityDetails.
Gets the realized_expression of this UpdateEntityDetails.
Gets the time_external of this UpdateEntityDetails.
Methods:
__init__(**kwargs)Initializes a new UpdateEntityDetails object with values from keyword arguments.
- HARVEST_STATUS_COMPLETE = 'COMPLETE'¶
A constant which can be used with the harvest_status property of a UpdateEntityDetails. This constant has a value of “COMPLETE”
- HARVEST_STATUS_DEFERRED = 'DEFERRED'¶
A constant which can be used with the harvest_status property of a UpdateEntityDetails. This constant has a value of “DEFERRED”
- HARVEST_STATUS_ERROR = 'ERROR'¶
A constant which can be used with the harvest_status property of a UpdateEntityDetails. 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 UpdateEntityDetails. This constant has a value of “IN_PROGRESS”
- __init__(**kwargs)¶
Initializes a new UpdateEntityDetails 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 UpdateEntityDetails.
business_name (str) – The value to assign to the business_name property of this UpdateEntityDetails.
description (str) – The value to assign to the description property of this UpdateEntityDetails.
time_external (datetime) – The value to assign to the time_external property of this UpdateEntityDetails.
is_logical (bool) – The value to assign to the is_logical property of this UpdateEntityDetails.
is_partition (bool) – The value to assign to the is_partition property of this UpdateEntityDetails.
folder_key (str) – The value to assign to the folder_key property of this UpdateEntityDetails.
pattern_key (str) – The value to assign to the pattern_key property of this UpdateEntityDetails.
realized_expression (str) – The value to assign to the realized_expression property of this UpdateEntityDetails.
harvest_status (str) – The value to assign to the harvest_status property of this UpdateEntityDetails. 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 UpdateEntityDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this UpdateEntityDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this UpdateEntityDetails.
- property business_name¶
Gets the business_name of this UpdateEntityDetails. 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 UpdateEntityDetails.
- Return type
str
- property custom_property_members¶
Gets the custom_property_members of this UpdateEntityDetails. The list of customized properties along with the values for this object
- Returns
The custom_property_members of this UpdateEntityDetails.
- Return type
- property description¶
Gets the description of this UpdateEntityDetails. Detailed description of a data entity.
- Returns
The description of this UpdateEntityDetails.
- Return type
str
- property display_name¶
Gets the display_name of this UpdateEntityDetails. 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 UpdateEntityDetails.
- Return type
str
- property folder_key¶
Gets the folder_key of this UpdateEntityDetails. Key of the associated folder.
- Returns
The folder_key of this UpdateEntityDetails.
- Return type
str
- property harvest_status¶
Gets the harvest_status of this UpdateEntityDetails. 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 UpdateEntityDetails.
- Return type
str
- property is_logical¶
Gets the is_logical of this UpdateEntityDetails. Property to indicate if the object is a physical materialized object or virtual. For example, View.
- Returns
The is_logical of this UpdateEntityDetails.
- Return type
bool
- property is_partition¶
Gets the is_partition of this UpdateEntityDetails. Property to indicate if the object is a sub object of a parent physical object.
- Returns
The is_partition of this UpdateEntityDetails.
- Return type
bool
- property last_job_key¶
Gets the last_job_key of this UpdateEntityDetails. Key of the last harvest process to update this object.
- Returns
The last_job_key of this UpdateEntityDetails.
- Return type
str
- property pattern_key¶
Gets the pattern_key of this UpdateEntityDetails. Key of the associated pattern if this is a logical entity.
- Returns
The pattern_key of this UpdateEntityDetails.
- Return type
str
- property properties¶
Gets the properties of this UpdateEntityDetails. 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 UpdateEntityDetails.
- Return type
dict(str, dict(str, str))
- property realized_expression¶
Gets the realized_expression of this UpdateEntityDetails. The expression realized after resolving qualifiers . Used in deriving this logical entity
- Returns
The realized_expression of this UpdateEntityDetails.
- Return type
str
- property time_external¶
Gets the time_external of this UpdateEntityDetails. Last modified timestamp of the object in the external system.
- Returns
The time_external of this UpdateEntityDetails.
- Return type
datetime