FolderSummary

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

Bases: object

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

Methods:

__init__(**kwargs)

Initializes a new FolderSummary object with values from keyword arguments.

Attributes:

category_name

Gets the category_name of this FolderSummary.

description

Gets the description of this FolderSummary.

identifier

Gets the identifier of this FolderSummary.

key

Gets the key of this FolderSummary.

key_map

Gets the key_map of this FolderSummary.

metadata

Gets the metadata of this FolderSummary.

model_type

Gets the model_type of this FolderSummary.

model_version

Gets the model_version of this FolderSummary.

name

Gets the name of this FolderSummary.

object_status

Gets the object_status of this FolderSummary.

object_version

Gets the object_version of this FolderSummary.

parent_ref

Gets the parent_ref of this FolderSummary.

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

property category_name

Gets the category_name of this FolderSummary. The category name.

Returns

The category_name of this FolderSummary.

Return type

str

property description

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

Returns

The description of this FolderSummary.

Return type

str

property identifier

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

Return type

str

property key

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

Returns

The key of this FolderSummary.

Return type

str

property key_map

Gets the key_map of this FolderSummary. 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 FolderSummary.

Return type

dict(str, str)

property metadata

Gets the metadata of this FolderSummary.

Returns

The metadata of this FolderSummary.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

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

Returns

The model_type of this FolderSummary.

Return type

str

property model_version

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

Returns

The model_version of this FolderSummary.

Return type

str

property name

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

Return type

str

property object_status

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

Return type

int

property object_version

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

Returns

The object_version of this FolderSummary.

Return type

int

property parent_ref

Gets the parent_ref of this FolderSummary.

Returns

The parent_ref of this FolderSummary.

Return type

oci.data_integration.models.ParentReference