File: //lib/mysqlsh/lib/python3.8/site-packages/oci/file_storage/models/file_system_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: 20171215
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 FileSystemSummary(object):
"""
Summary information for a file system.
"""
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "CREATING"
LIFECYCLE_STATE_CREATING = "CREATING"
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "UPDATING"
LIFECYCLE_STATE_UPDATING = "UPDATING"
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
#: A constant which can be used with the lifecycle_state property of a FileSystemSummary.
#: This constant has a value of "FAILED"
LIFECYCLE_STATE_FAILED = "FAILED"
#: A constant which can be used with the clone_attach_status property of a FileSystemSummary.
#: This constant has a value of "ATTACHED"
CLONE_ATTACH_STATUS_ATTACHED = "ATTACHED"
#: A constant which can be used with the clone_attach_status property of a FileSystemSummary.
#: This constant has a value of "DETACHING"
CLONE_ATTACH_STATUS_DETACHING = "DETACHING"
#: A constant which can be used with the clone_attach_status property of a FileSystemSummary.
#: This constant has a value of "DETACHED"
CLONE_ATTACH_STATUS_DETACHED = "DETACHED"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "ENABLING"
QUOTA_ENFORCEMENT_STATE_ENABLING = "ENABLING"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "ENABLED"
QUOTA_ENFORCEMENT_STATE_ENABLED = "ENABLED"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "DISABLING"
QUOTA_ENFORCEMENT_STATE_DISABLING = "DISABLING"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "DISABLED"
QUOTA_ENFORCEMENT_STATE_DISABLED = "DISABLED"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "SYNCING"
QUOTA_ENFORCEMENT_STATE_SYNCING = "SYNCING"
#: A constant which can be used with the quota_enforcement_state property of a FileSystemSummary.
#: This constant has a value of "FAILED"
QUOTA_ENFORCEMENT_STATE_FAILED = "FAILED"
def __init__(self, **kwargs):
"""
Initializes a new FileSystemSummary object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param availability_domain:
The value to assign to the availability_domain property of this FileSystemSummary.
:type availability_domain: str
:param metered_bytes:
The value to assign to the metered_bytes property of this FileSystemSummary.
:type metered_bytes: int
:param compartment_id:
The value to assign to the compartment_id property of this FileSystemSummary.
:type compartment_id: str
:param display_name:
The value to assign to the display_name property of this FileSystemSummary.
:type display_name: str
:param id:
The value to assign to the id property of this FileSystemSummary.
:type id: str
:param lifecycle_state:
The value to assign to the lifecycle_state property of this FileSystemSummary.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type lifecycle_state: str
:param time_created:
The value to assign to the time_created property of this FileSystemSummary.
:type time_created: datetime
:param locks:
The value to assign to the locks property of this FileSystemSummary.
:type locks: list[oci.file_storage.models.ResourceLock]
:param freeform_tags:
The value to assign to the freeform_tags property of this FileSystemSummary.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this FileSystemSummary.
:type defined_tags: dict(str, dict(str, object))
:param system_tags:
The value to assign to the system_tags property of this FileSystemSummary.
:type system_tags: dict(str, dict(str, object))
:param replication_source_count:
The value to assign to the replication_source_count property of this FileSystemSummary.
:type replication_source_count: int
:param kms_key_id:
The value to assign to the kms_key_id property of this FileSystemSummary.
:type kms_key_id: str
:param source_details:
The value to assign to the source_details property of this FileSystemSummary.
:type source_details: oci.file_storage.models.SourceDetails
:param is_clone_parent:
The value to assign to the is_clone_parent property of this FileSystemSummary.
:type is_clone_parent: bool
:param is_hydrated:
The value to assign to the is_hydrated property of this FileSystemSummary.
:type is_hydrated: bool
:param lifecycle_details:
The value to assign to the lifecycle_details property of this FileSystemSummary.
:type lifecycle_details: str
:param clone_attach_status:
The value to assign to the clone_attach_status property of this FileSystemSummary.
Allowed values for this property are: "ATTACHED", "DETACHING", "DETACHED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type clone_attach_status: str
:param quota_enforcement_state:
The value to assign to the quota_enforcement_state property of this FileSystemSummary.
Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "DISABLED", "SYNCING", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:type quota_enforcement_state: str
"""
self.swagger_types = {
'availability_domain': 'str',
'metered_bytes': 'int',
'compartment_id': 'str',
'display_name': 'str',
'id': 'str',
'lifecycle_state': 'str',
'time_created': 'datetime',
'locks': 'list[ResourceLock]',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'system_tags': 'dict(str, dict(str, object))',
'replication_source_count': 'int',
'kms_key_id': 'str',
'source_details': 'SourceDetails',
'is_clone_parent': 'bool',
'is_hydrated': 'bool',
'lifecycle_details': 'str',
'clone_attach_status': 'str',
'quota_enforcement_state': 'str'
}
self.attribute_map = {
'availability_domain': 'availabilityDomain',
'metered_bytes': 'meteredBytes',
'compartment_id': 'compartmentId',
'display_name': 'displayName',
'id': 'id',
'lifecycle_state': 'lifecycleState',
'time_created': 'timeCreated',
'locks': 'locks',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'system_tags': 'systemTags',
'replication_source_count': 'replicationSourceCount',
'kms_key_id': 'kmsKeyId',
'source_details': 'sourceDetails',
'is_clone_parent': 'isCloneParent',
'is_hydrated': 'isHydrated',
'lifecycle_details': 'lifecycleDetails',
'clone_attach_status': 'cloneAttachStatus',
'quota_enforcement_state': 'quotaEnforcementState'
}
self._availability_domain = None
self._metered_bytes = None
self._compartment_id = None
self._display_name = None
self._id = None
self._lifecycle_state = None
self._time_created = None
self._locks = None
self._freeform_tags = None
self._defined_tags = None
self._system_tags = None
self._replication_source_count = None
self._kms_key_id = None
self._source_details = None
self._is_clone_parent = None
self._is_hydrated = None
self._lifecycle_details = None
self._clone_attach_status = None
self._quota_enforcement_state = None
@property
def availability_domain(self):
"""
Gets the availability_domain of this FileSystemSummary.
The availability domain the file system is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
:return: The availability_domain of this FileSystemSummary.
:rtype: str
"""
return self._availability_domain
@availability_domain.setter
def availability_domain(self, availability_domain):
"""
Sets the availability_domain of this FileSystemSummary.
The availability domain the file system is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
:param availability_domain: The availability_domain of this FileSystemSummary.
:type: str
"""
self._availability_domain = availability_domain
@property
def metered_bytes(self):
"""
**[Required]** Gets the metered_bytes of this FileSystemSummary.
The number of bytes consumed by the file system, including
any snapshots. This number reflects the metered size of the file
system and is updated asynchronously with respect to
updates to the file system.
:return: The metered_bytes of this FileSystemSummary.
:rtype: int
"""
return self._metered_bytes
@metered_bytes.setter
def metered_bytes(self, metered_bytes):
"""
Sets the metered_bytes of this FileSystemSummary.
The number of bytes consumed by the file system, including
any snapshots. This number reflects the metered size of the file
system and is updated asynchronously with respect to
updates to the file system.
:param metered_bytes: The metered_bytes of this FileSystemSummary.
:type: int
"""
self._metered_bytes = metered_bytes
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this FileSystemSummary.
The `OCID`__ of the compartment that contains the file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The compartment_id of this FileSystemSummary.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this FileSystemSummary.
The `OCID`__ of the compartment that contains the file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param compartment_id: The compartment_id of this FileSystemSummary.
:type: str
"""
self._compartment_id = compartment_id
@property
def display_name(self):
"""
**[Required]** Gets the display_name of this FileSystemSummary.
A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
:return: The display_name of this FileSystemSummary.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this FileSystemSummary.
A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
:param display_name: The display_name of this FileSystemSummary.
:type: str
"""
self._display_name = display_name
@property
def id(self):
"""
**[Required]** Gets the id of this FileSystemSummary.
The `OCID`__ of the file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The id of this FileSystemSummary.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this FileSystemSummary.
The `OCID`__ of the file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param id: The id of this FileSystemSummary.
:type: str
"""
self._id = id
@property
def lifecycle_state(self):
"""
**[Required]** Gets the lifecycle_state of this FileSystemSummary.
The current state of the file system.
Allowed values for this property are: "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The lifecycle_state of this FileSystemSummary.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets the lifecycle_state of this FileSystemSummary.
The current state of the file system.
:param lifecycle_state: The lifecycle_state of this FileSystemSummary.
:type: str
"""
allowed_values = ["CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def time_created(self):
"""
**[Required]** Gets the time_created of this FileSystemSummary.
The date and time the file system was created, expressed
in `RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:return: The time_created of this FileSystemSummary.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets the time_created of this FileSystemSummary.
The date and time the file system was created, expressed
in `RFC 3339`__ timestamp format.
Example: `2016-08-25T21:10:29.600Z`
__ https://tools.ietf.org/rfc/rfc3339
:param time_created: The time_created of this FileSystemSummary.
:type: datetime
"""
self._time_created = time_created
@property
def locks(self):
"""
Gets the locks of this FileSystemSummary.
Locks associated with this resource.
:return: The locks of this FileSystemSummary.
:rtype: list[oci.file_storage.models.ResourceLock]
"""
return self._locks
@locks.setter
def locks(self, locks):
"""
Sets the locks of this FileSystemSummary.
Locks associated with this resource.
:param locks: The locks of this FileSystemSummary.
:type: list[oci.file_storage.models.ResourceLock]
"""
self._locks = locks
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this FileSystemSummary.
Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this FileSystemSummary.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this FileSystemSummary.
Free-form tags for this resource. Each tag is a simple key-value pair
with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this FileSystemSummary.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this FileSystemSummary.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this FileSystemSummary.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this FileSystemSummary.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this FileSystemSummary.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def system_tags(self):
"""
Gets the system_tags of this FileSystemSummary.
System tags for this resource.
System tags are applied to resources by internal OCI services.
:return: The system_tags of this FileSystemSummary.
:rtype: dict(str, dict(str, object))
"""
return self._system_tags
@system_tags.setter
def system_tags(self, system_tags):
"""
Sets the system_tags of this FileSystemSummary.
System tags for this resource.
System tags are applied to resources by internal OCI services.
:param system_tags: The system_tags of this FileSystemSummary.
:type: dict(str, dict(str, object))
"""
self._system_tags = system_tags
@property
def replication_source_count(self):
"""
Gets the replication_source_count of this FileSystemSummary.
Specifies the total number of replications for which this file system is a source.
:return: The replication_source_count of this FileSystemSummary.
:rtype: int
"""
return self._replication_source_count
@replication_source_count.setter
def replication_source_count(self, replication_source_count):
"""
Sets the replication_source_count of this FileSystemSummary.
Specifies the total number of replications for which this file system is a source.
:param replication_source_count: The replication_source_count of this FileSystemSummary.
:type: int
"""
self._replication_source_count = replication_source_count
@property
def kms_key_id(self):
"""
Gets the kms_key_id of this FileSystemSummary.
The `OCID`__ of the KMS key used to encrypt the encryption keys associated with this file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The kms_key_id of this FileSystemSummary.
:rtype: str
"""
return self._kms_key_id
@kms_key_id.setter
def kms_key_id(self, kms_key_id):
"""
Sets the kms_key_id of this FileSystemSummary.
The `OCID`__ of the KMS key used to encrypt the encryption keys associated with this file system.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param kms_key_id: The kms_key_id of this FileSystemSummary.
:type: str
"""
self._kms_key_id = kms_key_id
@property
def source_details(self):
"""
Gets the source_details of this FileSystemSummary.
:return: The source_details of this FileSystemSummary.
:rtype: oci.file_storage.models.SourceDetails
"""
return self._source_details
@source_details.setter
def source_details(self, source_details):
"""
Sets the source_details of this FileSystemSummary.
:param source_details: The source_details of this FileSystemSummary.
:type: oci.file_storage.models.SourceDetails
"""
self._source_details = source_details
@property
def is_clone_parent(self):
"""
Gets the is_clone_parent of this FileSystemSummary.
Specifies whether the file system has been cloned.
See `Cloning a File System`__.
__ https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm
:return: The is_clone_parent of this FileSystemSummary.
:rtype: bool
"""
return self._is_clone_parent
@is_clone_parent.setter
def is_clone_parent(self, is_clone_parent):
"""
Sets the is_clone_parent of this FileSystemSummary.
Specifies whether the file system has been cloned.
See `Cloning a File System`__.
__ https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm
:param is_clone_parent: The is_clone_parent of this FileSystemSummary.
:type: bool
"""
self._is_clone_parent = is_clone_parent
@property
def is_hydrated(self):
"""
Gets the is_hydrated of this FileSystemSummary.
Specifies whether the data has finished copying from the source to the clone.
Hydration can take up to several hours to complete depending on the size of the source.
The source and clone remain available during hydration, but there may be some performance impact.
See `Cloning a File System`__.
__ https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration
:return: The is_hydrated of this FileSystemSummary.
:rtype: bool
"""
return self._is_hydrated
@is_hydrated.setter
def is_hydrated(self, is_hydrated):
"""
Sets the is_hydrated of this FileSystemSummary.
Specifies whether the data has finished copying from the source to the clone.
Hydration can take up to several hours to complete depending on the size of the source.
The source and clone remain available during hydration, but there may be some performance impact.
See `Cloning a File System`__.
__ https://docs.cloud.oracle.com/iaas/Content/File/Tasks/cloningFS.htm#hydration
:param is_hydrated: The is_hydrated of this FileSystemSummary.
:type: bool
"""
self._is_hydrated = is_hydrated
@property
def lifecycle_details(self):
"""
Gets the lifecycle_details of this FileSystemSummary.
Additional information about the current 'lifecycleState'.
:return: The lifecycle_details of this FileSystemSummary.
:rtype: str
"""
return self._lifecycle_details
@lifecycle_details.setter
def lifecycle_details(self, lifecycle_details):
"""
Sets the lifecycle_details of this FileSystemSummary.
Additional information about the current 'lifecycleState'.
:param lifecycle_details: The lifecycle_details of this FileSystemSummary.
:type: str
"""
self._lifecycle_details = lifecycle_details
@property
def clone_attach_status(self):
"""
Gets the clone_attach_status of this FileSystemSummary.
Specifies whether the file system is attached to its parent file system.
Allowed values for this property are: "ATTACHED", "DETACHING", "DETACHED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The clone_attach_status of this FileSystemSummary.
:rtype: str
"""
return self._clone_attach_status
@clone_attach_status.setter
def clone_attach_status(self, clone_attach_status):
"""
Sets the clone_attach_status of this FileSystemSummary.
Specifies whether the file system is attached to its parent file system.
:param clone_attach_status: The clone_attach_status of this FileSystemSummary.
:type: str
"""
allowed_values = ["ATTACHED", "DETACHING", "DETACHED"]
if not value_allowed_none_or_none_sentinel(clone_attach_status, allowed_values):
clone_attach_status = 'UNKNOWN_ENUM_VALUE'
self._clone_attach_status = clone_attach_status
@property
def quota_enforcement_state(self):
"""
Gets the quota_enforcement_state of this FileSystemSummary.
Displays the state of enforcement of quota rules on the file system.
Allowed values for this property are: "ENABLING", "ENABLED", "DISABLING", "DISABLED", "SYNCING", "FAILED", 'UNKNOWN_ENUM_VALUE'.
Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
:return: The quota_enforcement_state of this FileSystemSummary.
:rtype: str
"""
return self._quota_enforcement_state
@quota_enforcement_state.setter
def quota_enforcement_state(self, quota_enforcement_state):
"""
Sets the quota_enforcement_state of this FileSystemSummary.
Displays the state of enforcement of quota rules on the file system.
:param quota_enforcement_state: The quota_enforcement_state of this FileSystemSummary.
:type: str
"""
allowed_values = ["ENABLING", "ENABLED", "DISABLING", "DISABLED", "SYNCING", "FAILED"]
if not value_allowed_none_or_none_sentinel(quota_enforcement_state, allowed_values):
quota_enforcement_state = 'UNKNOWN_ENUM_VALUE'
self._quota_enforcement_state = quota_enforcement_state
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