CreateFolderDetails¶

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

Bases: object

Properties used in folder create operations.

Attributes

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

Methods

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

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

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

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

__init__(**kwargs)¶

Initializes a new CreateFolderDetails 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 CreateFolderDetails.
business_name (str) – The value to assign to the business_name property of this CreateFolderDetails.
description (str) – The value to assign to the description property of this CreateFolderDetails.
custom_property_members (list[oci.data_catalog.models.CustomPropertySetUsage]) – The value to assign to the custom_property_members property of this CreateFolderDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreateFolderDetails.
parent_folder_key (str) – The value to assign to the parent_folder_key property of this CreateFolderDetails.
time_external (datetime) – The value to assign to the time_external property of this CreateFolderDetails.
last_job_key (str) – The value to assign to the last_job_key property of this CreateFolderDetails.
harvest_status (str) – The value to assign to the harvest_status property of this CreateFolderDetails. Allowed values for this property are: “COMPLETE”, “ERROR”, “IN_PROGRESS”, “DEFERRED”
type_key (str) – The value to assign to the type_key property of this CreateFolderDetails.

business_name¶

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

custom_property_members¶

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

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

description¶

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

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

display_name¶

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

harvest_status¶

Gets the harvest_status of this CreateFolderDetails. Folder harvesting status.

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

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

last_job_key¶

Gets the last_job_key of this CreateFolderDetails. The job key of the harvest process that updated the folder definition from the source system.

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

parent_folder_key¶

Gets the parent_folder_key of this CreateFolderDetails. The key of the containing folder or null if there isn’t a parent folder.

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

properties¶

Gets the properties of this CreateFolderDetails. 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 CreateFolderDetails.
Return type:	dict(str, dict(str, str))

time_external¶

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

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

type_key¶

Gets the type_key of this CreateFolderDetails. Type key of the object. Type keys can be found via the ‘/types’ endpoint.

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