FolderDetails¶
- class oci.data_integration.models.FolderDetails(**kwargs)¶
Bases:
objectThe details including name, description for the folder, which is a container of other folders, tasks and dataflows.
Methods:
__init__(**kwargs)Initializes a new FolderDetails object with values from keyword arguments.
Attributes:
Gets the category_name of this FolderDetails.
Gets the description of this FolderDetails.
Gets the identifier of this FolderDetails.
[Required] Gets the key of this FolderDetails.
[Required] Gets the model_type of this FolderDetails.
Gets the model_version of this FolderDetails.
Gets the name of this FolderDetails.
Gets the object_status of this FolderDetails.
[Required] Gets the object_version of this FolderDetails.
Gets the parent_ref of this FolderDetails.
Gets the registry_metadata of this FolderDetails.
- __init__(**kwargs)¶
Initializes a new FolderDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
key (str) – The value to assign to the key property of this FolderDetails.
model_type (str) – The value to assign to the model_type property of this FolderDetails.
model_version (str) – The value to assign to the model_version property of this FolderDetails.
name (str) – The value to assign to the name property of this FolderDetails.
description (str) – The value to assign to the description property of this FolderDetails.
category_name (str) – The value to assign to the category_name property of this FolderDetails.
object_status (int) – The value to assign to the object_status property of this FolderDetails.
identifier (str) – The value to assign to the identifier property of this FolderDetails.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this FolderDetails.
object_version (int) – The value to assign to the object_version property of this FolderDetails.
registry_metadata (oci.data_integration.models.RegistryMetadata) – The value to assign to the registry_metadata property of this FolderDetails.
- property category_name¶
Gets the category_name of this FolderDetails. The category name.
- Returns
The category_name of this FolderDetails.
- Return type
str
- property description¶
Gets the description of this FolderDetails. A user defined description for the folder.
- Returns
The description of this FolderDetails.
- Return type
str
- property identifier¶
Gets the identifier of this FolderDetails. 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 FolderDetails.
- Return type
str
- property key¶
[Required] Gets the key of this FolderDetails. Generated key that can be used in API calls to identify folder.
- Returns
The key of this FolderDetails.
- Return type
str
- property model_type¶
[Required] Gets the model_type of this FolderDetails. The type of the object.
- Returns
The model_type of this FolderDetails.
- Return type
str
- property model_version¶
Gets the model_version of this FolderDetails. The model version of an object.
- Returns
The model_version of this FolderDetails.
- Return type
str
- property name¶
Gets the name of this FolderDetails. 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 FolderDetails.
- Return type
str
- property object_status¶
Gets the object_status of this FolderDetails. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
- Returns
The object_status of this FolderDetails.
- Return type
int
- property object_version¶
[Required] Gets the object_version of this FolderDetails. The version of the object that is used to track changes in the object instance.
- Returns
The object_version of this FolderDetails.
- Return type
int
- property parent_ref¶
Gets the parent_ref of this FolderDetails.
- Returns
The parent_ref of this FolderDetails.
- Return type
- property registry_metadata¶
Gets the registry_metadata of this FolderDetails.
- Returns
The registry_metadata of this FolderDetails.
- Return type