UpdateFolderDetails¶

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

Bases: object

Properties used in folder update operations.

Attributes

`HARVEST_STATUS_COMPLETE`	A constant which can be used with the harvest_status property of a UpdateFolderDetails.
`HARVEST_STATUS_DEFERRED`	A constant which can be used with the harvest_status property of a UpdateFolderDetails.
`HARVEST_STATUS_ERROR`	A constant which can be used with the harvest_status property of a UpdateFolderDetails.
`HARVEST_STATUS_IN_PROGRESS`	A constant which can be used with the harvest_status property of a UpdateFolderDetails.
`business_name`	Gets the business_name of this UpdateFolderDetails.
`custom_property_members`	Gets the custom_property_members of this UpdateFolderDetails.
`description`	Gets the description of this UpdateFolderDetails.
`display_name`	Gets the display_name of this UpdateFolderDetails.
`harvest_status`	Gets the harvest_status of this UpdateFolderDetails.
`last_job_key`	Gets the last_job_key of this UpdateFolderDetails.
`parent_folder_key`	Gets the parent_folder_key of this UpdateFolderDetails.
`properties`	Gets the properties of this UpdateFolderDetails.
`time_external`	Gets the time_external of this UpdateFolderDetails.

Methods

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

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

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

HARVEST_STATUS_ERROR = 'ERROR'¶: A constant which can be used with the harvest_status property of a UpdateFolderDetails. 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 UpdateFolderDetails. This constant has a value of “IN_PROGRESS”

__init__(**kwargs)¶

Initializes a new UpdateFolderDetails 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 UpdateFolderDetails.
business_name (str) – The value to assign to the business_name property of this UpdateFolderDetails.
description (str) – The value to assign to the description property of this UpdateFolderDetails.
parent_folder_key (str) – The value to assign to the parent_folder_key property of this UpdateFolderDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this UpdateFolderDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this UpdateFolderDetails.
time_external (datetime) – The value to assign to the time_external property of this UpdateFolderDetails.
harvest_status (str) – The value to assign to the harvest_status property of this UpdateFolderDetails. 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 UpdateFolderDetails.

business_name¶

Gets the business_name of this UpdateFolderDetails. Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.

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

custom_property_members¶

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

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

description¶

Gets the description of this UpdateFolderDetails. Detailed description of a folder.

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

display_name¶

Gets the display_name of this UpdateFolderDetails. 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 UpdateFolderDetails.
Return type:	str

harvest_status¶

Gets the harvest_status of this UpdateFolderDetails. Harvest status of the folder.

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

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

last_job_key¶

Gets the last_job_key of this UpdateFolderDetails. The key of the last harvest process to update the metadata of this object.

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

parent_folder_key¶

Gets the parent_folder_key of this UpdateFolderDetails. The key of the containing folder.

Returns:	The parent_folder_key of this UpdateFolderDetails.
Return type:	str

properties¶

Gets the properties of this UpdateFolderDetails. A map of maps that contains the properties which are specific to the folder type. Each folder 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 folders have required properties within the “default” category. To determine the set of optional and required properties for a folder type, a query can be done on ‘/types?type=folder’ that returns a collection of all folder types. The appropriate folder 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 UpdateFolderDetails.
Return type:	dict(str, dict(str, str))

time_external¶

Gets the time_external of this UpdateFolderDetails. Last modified timestamp of this object in the external system.

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