oci 2.145.0__py3-none-any.whl → 2.147.0__py3-none-any.whl

oci/file_storage/models/file_system_summary.py

@@ -51,6 +51,30 @@ class FileSystemSummary(object):
     #: 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.
@@ -102,6 +126,10 @@ class FileSystemSummary(object):
             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
@@ -128,6 +156,12 @@ class FileSystemSummary(object):
             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',
@@ -141,12 +175,14 @@ class FileSystemSummary(object):
             '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'
+            'clone_attach_status': 'str',
+            'quota_enforcement_state': 'str'
         }
 
         self.attribute_map = {
@@ -161,12 +197,14 @@ class FileSystemSummary(object):
             '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'
+            'clone_attach_status': 'cloneAttachStatus',
+            'quota_enforcement_state': 'quotaEnforcementState'
         }
 
         self._availability_domain = None
@@ -180,12 +218,14 @@ class FileSystemSummary(object):
         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):
@@ -513,6 +553,30 @@ class FileSystemSummary(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):
         """
@@ -679,6 +743,36 @@ class FileSystemSummary(object):
             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)
 

oci/file_storage/models/quota_rule.py

@@ -0,0 +1,384 @@
+# 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 QuotaRule(object):
+    """
+    A rule that can restrict the logical space that a user or group can consume in a file system.
+    """
+
+    #: A constant which can be used with the principal_type property of a QuotaRule.
+    #: This constant has a value of "FILE_SYSTEM_LEVEL"
+    PRINCIPAL_TYPE_FILE_SYSTEM_LEVEL = "FILE_SYSTEM_LEVEL"
+
+    #: A constant which can be used with the principal_type property of a QuotaRule.
+    #: This constant has a value of "DEFAULT_GROUP"
+    PRINCIPAL_TYPE_DEFAULT_GROUP = "DEFAULT_GROUP"
+
+    #: A constant which can be used with the principal_type property of a QuotaRule.
+    #: This constant has a value of "DEFAULT_USER"
+    PRINCIPAL_TYPE_DEFAULT_USER = "DEFAULT_USER"
+
+    #: A constant which can be used with the principal_type property of a QuotaRule.
+    #: This constant has a value of "INDIVIDUAL_GROUP"
+    PRINCIPAL_TYPE_INDIVIDUAL_GROUP = "INDIVIDUAL_GROUP"
+
+    #: A constant which can be used with the principal_type property of a QuotaRule.
+    #: This constant has a value of "INDIVIDUAL_USER"
+    PRINCIPAL_TYPE_INDIVIDUAL_USER = "INDIVIDUAL_USER"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new QuotaRule object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param id:
+            The value to assign to the id property of this QuotaRule.
+        :type id: str
+
+        :param file_system_id:
+            The value to assign to the file_system_id property of this QuotaRule.
+        :type file_system_id: str
+
+        :param principal_type:
+            The value to assign to the principal_type property of this QuotaRule.
+            Allowed values for this property are: "FILE_SYSTEM_LEVEL", "DEFAULT_GROUP", "DEFAULT_USER", "INDIVIDUAL_GROUP", "INDIVIDUAL_USER", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type principal_type: str
+
+        :param principal_id:
+            The value to assign to the principal_id property of this QuotaRule.
+        :type principal_id: int
+
+        :param is_hard_quota:
+            The value to assign to the is_hard_quota property of this QuotaRule.
+        :type is_hard_quota: bool
+
+        :param display_name:
+            The value to assign to the display_name property of this QuotaRule.
+        :type display_name: str
+
+        :param quota_limit_in_gigabytes:
+            The value to assign to the quota_limit_in_gigabytes property of this QuotaRule.
+        :type quota_limit_in_gigabytes: int
+
+        :param time_created:
+            The value to assign to the time_created property of this QuotaRule.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this QuotaRule.
+        :type time_updated: datetime
+
+        """
+        self.swagger_types = {
+            'id': 'str',
+            'file_system_id': 'str',
+            'principal_type': 'str',
+            'principal_id': 'int',
+            'is_hard_quota': 'bool',
+            'display_name': 'str',
+            'quota_limit_in_gigabytes': 'int',
+            'time_created': 'datetime',
+            'time_updated': 'datetime'
+        }
+
+        self.attribute_map = {
+            'id': 'id',
+            'file_system_id': 'fileSystemId',
+            'principal_type': 'principalType',
+            'principal_id': 'principalId',
+            'is_hard_quota': 'isHardQuota',
+            'display_name': 'displayName',
+            'quota_limit_in_gigabytes': 'quotaLimitInGigabytes',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated'
+        }
+
+        self._id = None
+        self._file_system_id = None
+        self._principal_type = None
+        self._principal_id = None
+        self._is_hard_quota = None
+        self._display_name = None
+        self._quota_limit_in_gigabytes = None
+        self._time_created = None
+        self._time_updated = None
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this QuotaRule.
+        The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
+
+
+        :return: The id of this QuotaRule.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this QuotaRule.
+        The identifier of the quota rule. It is the base64 encoded string of the tuple <principalId, principalType, isHardQuota>.
+
+
+        :param id: The id of this QuotaRule.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def file_system_id(self):
+        """
+        **[Required]** Gets the file_system_id of this QuotaRule.
+        The `OCID`__ of the file System.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The file_system_id of this QuotaRule.
+        :rtype: str
+        """
+        return self._file_system_id
+
+    @file_system_id.setter
+    def file_system_id(self, file_system_id):
+        """
+        Sets the file_system_id of this QuotaRule.
+        The `OCID`__ of the file System.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param file_system_id: The file_system_id of this QuotaRule.
+        :type: str
+        """
+        self._file_system_id = file_system_id
+
+    @property
+    def principal_type(self):
+        """
+        Gets the principal_type of this QuotaRule.
+        The type of the owner of this quota rule and usage.
+
+        Allowed values for this property are: "FILE_SYSTEM_LEVEL", "DEFAULT_GROUP", "DEFAULT_USER", "INDIVIDUAL_GROUP", "INDIVIDUAL_USER", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The principal_type of this QuotaRule.
+        :rtype: str
+        """
+        return self._principal_type
+
+    @principal_type.setter
+    def principal_type(self, principal_type):
+        """
+        Sets the principal_type of this QuotaRule.
+        The type of the owner of this quota rule and usage.
+
+
+        :param principal_type: The principal_type of this QuotaRule.
+        :type: str
+        """
+        allowed_values = ["FILE_SYSTEM_LEVEL", "DEFAULT_GROUP", "DEFAULT_USER", "INDIVIDUAL_GROUP", "INDIVIDUAL_USER"]
+        if not value_allowed_none_or_none_sentinel(principal_type, allowed_values):
+            principal_type = 'UNKNOWN_ENUM_VALUE'
+        self._principal_type = principal_type
+
+    @property
+    def principal_id(self):
+        """
+        Gets the principal_id of this QuotaRule.
+        An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
+        identify a user or group to manage access control.
+
+
+        :return: The principal_id of this QuotaRule.
+        :rtype: int
+        """
+        return self._principal_id
+
+    @principal_id.setter
+    def principal_id(self, principal_id):
+        """
+        Sets the principal_id of this QuotaRule.
+        An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
+        identify a user or group to manage access control.
+
+
+        :param principal_id: The principal_id of this QuotaRule.
+        :type: int
+        """
+        self._principal_id = principal_id
+
+    @property
+    def is_hard_quota(self):
+        """
+        **[Required]** Gets the is_hard_quota of this QuotaRule.
+        Whether the quota rule will be enforced.
+        If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
+        exceeds the hard quota limit.
+        If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
+
+
+        :return: The is_hard_quota of this QuotaRule.
+        :rtype: bool
+        """
+        return self._is_hard_quota
+
+    @is_hard_quota.setter
+    def is_hard_quota(self, is_hard_quota):
+        """
+        Sets the is_hard_quota of this QuotaRule.
+        Whether the quota rule will be enforced.
+        If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
+        exceeds the hard quota limit.
+        If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
+
+
+        :param is_hard_quota: The is_hard_quota of this QuotaRule.
+        :type: bool
+        """
+        self._is_hard_quota = is_hard_quota
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this QuotaRule.
+        A user-friendly name. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+        Example: `UserXYZ's quota`
+
+
+        :return: The display_name of this QuotaRule.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this QuotaRule.
+        A user-friendly name. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+        Example: `UserXYZ's quota`
+
+
+        :param display_name: The display_name of this QuotaRule.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def quota_limit_in_gigabytes(self):
+        """
+        **[Required]** Gets the quota_limit_in_gigabytes of this QuotaRule.
+        The value of the quota rule in gigabytes.
+
+
+        :return: The quota_limit_in_gigabytes of this QuotaRule.
+        :rtype: int
+        """
+        return self._quota_limit_in_gigabytes
+
+    @quota_limit_in_gigabytes.setter
+    def quota_limit_in_gigabytes(self, quota_limit_in_gigabytes):
+        """
+        Sets the quota_limit_in_gigabytes of this QuotaRule.
+        The value of the quota rule in gigabytes.
+
+
+        :param quota_limit_in_gigabytes: The quota_limit_in_gigabytes of this QuotaRule.
+        :type: int
+        """
+        self._quota_limit_in_gigabytes = quota_limit_in_gigabytes
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this QuotaRule.
+        The date and time the quota rule 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 QuotaRule.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this QuotaRule.
+        The date and time the quota rule 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 QuotaRule.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def time_updated(self):
+        """
+        **[Required]** Gets the time_updated of this QuotaRule.
+        The date and time the quota rule was last updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
+
+
+        :return: The time_updated of this QuotaRule.
+        :rtype: datetime
+        """
+        return self._time_updated
+
+    @time_updated.setter
+    def time_updated(self, time_updated):
+        """
+        Sets the time_updated of this QuotaRule.
+        The date and time the quota rule was last updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
+
+
+        :param time_updated: The time_updated of this QuotaRule.
+        :type: datetime
+        """
+        self._time_updated = time_updated
+
+    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