File: //lib/mysqlsh/lib/python3.8/site-packages/oci/data_integration/models/folder_summary.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200430
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class FolderSummary(object):
"""
The folder summary type contains the audit summary information and the definition of the folder.
"""
def __init__(self, **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):
:param key:
The value to assign to the key property of this FolderSummary.
:type key: str
:param model_type:
The value to assign to the model_type property of this FolderSummary.
:type model_type: str
:param model_version:
The value to assign to the model_version property of this FolderSummary.
:type model_version: str
:param name:
The value to assign to the name property of this FolderSummary.
:type name: str
:param description:
The value to assign to the description property of this FolderSummary.
:type description: str
:param category_name:
The value to assign to the category_name property of this FolderSummary.
:type category_name: str
:param object_status:
The value to assign to the object_status property of this FolderSummary.
:type object_status: int
:param identifier:
The value to assign to the identifier property of this FolderSummary.
:type identifier: str
:param parent_ref:
The value to assign to the parent_ref property of this FolderSummary.
:type parent_ref: oci.data_integration.models.ParentReference
:param object_version:
The value to assign to the object_version property of this FolderSummary.
:type object_version: int
:param metadata:
The value to assign to the metadata property of this FolderSummary.
:type metadata: oci.data_integration.models.ObjectMetadata
:param key_map:
The value to assign to the key_map property of this FolderSummary.
:type key_map: dict(str, str)
"""
self.swagger_types = {
'key': 'str',
'model_type': 'str',
'model_version': 'str',
'name': 'str',
'description': 'str',
'category_name': 'str',
'object_status': 'int',
'identifier': 'str',
'parent_ref': 'ParentReference',
'object_version': 'int',
'metadata': 'ObjectMetadata',
'key_map': 'dict(str, str)'
}
self.attribute_map = {
'key': 'key',
'model_type': 'modelType',
'model_version': 'modelVersion',
'name': 'name',
'description': 'description',
'category_name': 'categoryName',
'object_status': 'objectStatus',
'identifier': 'identifier',
'parent_ref': 'parentRef',
'object_version': 'objectVersion',
'metadata': 'metadata',
'key_map': 'keyMap'
}
self._key = None
self._model_type = None
self._model_version = None
self._name = None
self._description = None
self._category_name = None
self._object_status = None
self._identifier = None
self._parent_ref = None
self._object_version = None
self._metadata = None
self._key_map = None
@property
def key(self):
"""
Gets the key of this FolderSummary.
Generated key that can be used in API calls to identify folder.
:return: The key of this FolderSummary.
:rtype: str
"""
return self._key
@key.setter
def key(self, key):
"""
Sets the key of this FolderSummary.
Generated key that can be used in API calls to identify folder.
:param key: The key of this FolderSummary.
:type: str
"""
self._key = key
@property
def model_type(self):
"""
Gets the model_type of this FolderSummary.
The type of the object.
:return: The model_type of this FolderSummary.
:rtype: str
"""
return self._model_type
@model_type.setter
def model_type(self, model_type):
"""
Sets the model_type of this FolderSummary.
The type of the object.
:param model_type: The model_type of this FolderSummary.
:type: str
"""
self._model_type = model_type
@property
def model_version(self):
"""
Gets the model_version of this FolderSummary.
The model version of an object.
:return: The model_version of this FolderSummary.
:rtype: str
"""
return self._model_version
@model_version.setter
def model_version(self, model_version):
"""
Sets the model_version of this FolderSummary.
The model version of an object.
:param model_version: The model_version of this FolderSummary.
:type: str
"""
self._model_version = model_version
@property
def name(self):
"""
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.
:return: The name of this FolderSummary.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets 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.
:param name: The name of this FolderSummary.
:type: str
"""
self._name = name
@property
def description(self):
"""
Gets the description of this FolderSummary.
A user defined description for the folder.
:return: The description of this FolderSummary.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this FolderSummary.
A user defined description for the folder.
:param description: The description of this FolderSummary.
:type: str
"""
self._description = description
@property
def category_name(self):
"""
Gets the category_name of this FolderSummary.
The category name.
:return: The category_name of this FolderSummary.
:rtype: str
"""
return self._category_name
@category_name.setter
def category_name(self, category_name):
"""
Sets the category_name of this FolderSummary.
The category name.
:param category_name: The category_name of this FolderSummary.
:type: str
"""
self._category_name = category_name
@property
def object_status(self):
"""
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.
:return: The object_status of this FolderSummary.
:rtype: int
"""
return self._object_status
@object_status.setter
def object_status(self, object_status):
"""
Sets 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.
:param object_status: The object_status of this FolderSummary.
:type: int
"""
self._object_status = object_status
@property
def identifier(self):
"""
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.
:return: The identifier of this FolderSummary.
:rtype: str
"""
return self._identifier
@identifier.setter
def identifier(self, identifier):
"""
Sets 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.
:param identifier: The identifier of this FolderSummary.
:type: str
"""
self._identifier = identifier
@property
def parent_ref(self):
"""
Gets the parent_ref of this FolderSummary.
:return: The parent_ref of this FolderSummary.
:rtype: oci.data_integration.models.ParentReference
"""
return self._parent_ref
@parent_ref.setter
def parent_ref(self, parent_ref):
"""
Sets the parent_ref of this FolderSummary.
:param parent_ref: The parent_ref of this FolderSummary.
:type: oci.data_integration.models.ParentReference
"""
self._parent_ref = parent_ref
@property
def object_version(self):
"""
Gets the object_version of this FolderSummary.
The version of the object that is used to track changes in the object instance.
:return: The object_version of this FolderSummary.
:rtype: int
"""
return self._object_version
@object_version.setter
def object_version(self, object_version):
"""
Sets the object_version of this FolderSummary.
The version of the object that is used to track changes in the object instance.
:param object_version: The object_version of this FolderSummary.
:type: int
"""
self._object_version = object_version
@property
def metadata(self):
"""
Gets the metadata of this FolderSummary.
:return: The metadata of this FolderSummary.
:rtype: oci.data_integration.models.ObjectMetadata
"""
return self._metadata
@metadata.setter
def metadata(self, metadata):
"""
Sets the metadata of this FolderSummary.
:param metadata: The metadata of this FolderSummary.
:type: oci.data_integration.models.ObjectMetadata
"""
self._metadata = metadata
@property
def key_map(self):
"""
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.
:return: The key_map of this FolderSummary.
:rtype: dict(str, str)
"""
return self._key_map
@key_map.setter
def key_map(self, key_map):
"""
Sets 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.
:param key_map: The key_map of this FolderSummary.
:type: dict(str, str)
"""
self._key_map = key_map
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other