Folder

class oci.data_integration.models.Folder(**kwargs)

Bases: object

The folder type contains the audit summary information and the definition of the folder.

Methods:

__init__(**kwargs)

Initializes a new Folder object with values from keyword arguments.

Attributes:

category_name

Gets the category_name of this Folder.

description

Gets the description of this Folder.

identifier

Gets the identifier of this Folder.

key

Gets the key of this Folder.

key_map

Gets the key_map of this Folder.

metadata

Gets the metadata of this Folder.

model_type

Gets the model_type of this Folder.

model_version

Gets the model_version of this Folder.

name

Gets the name of this Folder.

object_status

Gets the object_status of this Folder.

object_version

Gets the object_version of this Folder.

parent_ref

Gets the parent_ref of this Folder.

__init__(**kwargs)

Initializes a new Folder 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 Folder.

  • model_type (str) – The value to assign to the model_type property of this Folder.

  • model_version (str) – The value to assign to the model_version property of this Folder.

  • name (str) – The value to assign to the name property of this Folder.

  • description (str) – The value to assign to the description property of this Folder.

  • category_name (str) – The value to assign to the category_name property of this Folder.

  • object_status (int) – The value to assign to the object_status property of this Folder.

  • identifier (str) – The value to assign to the identifier property of this Folder.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Folder.

  • object_version (int) – The value to assign to the object_version property of this Folder.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this Folder.

  • key_map (dict(str, str)) – The value to assign to the key_map property of this Folder.

property category_name

Gets the category_name of this Folder. The category name.

Returns

The category_name of this Folder.

Return type

str

property description

Gets the description of this Folder. A user defined description for the folder.

Returns

The description of this Folder.

Return type

str

property identifier

Gets the identifier of this Folder. 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 Folder.

Return type

str

property key

Gets the key of this Folder. Generated key that can be used in API calls to identify folder.

Returns

The key of this Folder.

Return type

str

property key_map

Gets the key_map of this Folder. A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns

The key_map of this Folder.

Return type

dict(str, str)

property metadata

Gets the metadata of this Folder.

Returns

The metadata of this Folder.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

Gets the model_type of this Folder. The type of the object.

Returns

The model_type of this Folder.

Return type

str

property model_version

Gets the model_version of this Folder. The model version of an object.

Returns

The model_version of this Folder.

Return type

str

property name

Gets the name of this Folder. 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 Folder.

Return type

str

property object_status

Gets the object_status of this Folder. 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 Folder.

Return type

int

property object_version

Gets the object_version of this Folder. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this Folder.

Return type

int

property parent_ref

Gets the parent_ref of this Folder.

Returns

The parent_ref of this Folder.

Return type

oci.data_integration.models.ParentReference