mv-oci-sdk 2.142.0__py3-none-any.whl → 2.142.0.1__py3-none-any.whl

oci/file_storage/models/export_set_summary.py

@@ -0,0 +1,316 @@
+# 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 ExportSetSummary(object):
+    """
+    Summary information for an export set.
+    """
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSetSummary.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSetSummary.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSetSummary.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSetSummary.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ExportSetSummary 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 ExportSetSummary.
+        :type availability_domain: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this ExportSetSummary.
+        :type compartment_id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this ExportSetSummary.
+        :type display_name: str
+
+        :param id:
+            The value to assign to the id property of this ExportSetSummary.
+        :type id: str
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this ExportSetSummary.
+            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", '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 ExportSetSummary.
+        :type time_created: datetime
+
+        :param vcn_id:
+            The value to assign to the vcn_id property of this ExportSetSummary.
+        :type vcn_id: str
+
+        """
+        self.swagger_types = {
+            'availability_domain': 'str',
+            'compartment_id': 'str',
+            'display_name': 'str',
+            'id': 'str',
+            'lifecycle_state': 'str',
+            'time_created': 'datetime',
+            'vcn_id': 'str'
+        }
+
+        self.attribute_map = {
+            'availability_domain': 'availabilityDomain',
+            'compartment_id': 'compartmentId',
+            'display_name': 'displayName',
+            'id': 'id',
+            'lifecycle_state': 'lifecycleState',
+            'time_created': 'timeCreated',
+            'vcn_id': 'vcnId'
+        }
+
+        self._availability_domain = None
+        self._compartment_id = None
+        self._display_name = None
+        self._id = None
+        self._lifecycle_state = None
+        self._time_created = None
+        self._vcn_id = None
+
+    @property
+    def availability_domain(self):
+        """
+        Gets the availability_domain of this ExportSetSummary.
+        The availability domain the export set is in. May be unset
+        as a blank or NULL value.
+
+        Example: `Uocm:PHX-AD-1`
+
+
+        :return: The availability_domain of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._availability_domain
+
+    @availability_domain.setter
+    def availability_domain(self, availability_domain):
+        """
+        Sets the availability_domain of this ExportSetSummary.
+        The availability domain the export set is in. May be unset
+        as a blank or NULL value.
+
+        Example: `Uocm:PHX-AD-1`
+
+
+        :param availability_domain: The availability_domain of this ExportSetSummary.
+        :type: str
+        """
+        self._availability_domain = availability_domain
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this ExportSetSummary.
+        The `OCID`__ of the compartment that contains the export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The compartment_id of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this ExportSetSummary.
+        The `OCID`__ of the compartment that contains the export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param compartment_id: The compartment_id of this ExportSetSummary.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def display_name(self):
+        """
+        **[Required]** Gets the display_name of this ExportSetSummary.
+        A user-friendly name. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+
+        Example: `My export set`
+
+
+        :return: The display_name of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this ExportSetSummary.
+        A user-friendly name. It does not have to be unique, and it is changeable.
+        Avoid entering confidential information.
+
+        Example: `My export set`
+
+
+        :param display_name: The display_name of this ExportSetSummary.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this ExportSetSummary.
+        The `OCID`__ of the export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this ExportSetSummary.
+        The `OCID`__ of the export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this ExportSetSummary.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this ExportSetSummary.
+        The current state of the export set.
+
+        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_state of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this ExportSetSummary.
+        The current state of the export set.
+
+
+        :param lifecycle_state: The lifecycle_state of this ExportSetSummary.
+        :type: str
+        """
+        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED"]
+        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 ExportSetSummary.
+        The date and time the export set 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 ExportSetSummary.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this ExportSetSummary.
+        The date and time the export set 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 ExportSetSummary.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def vcn_id(self):
+        """
+        **[Required]** Gets the vcn_id of this ExportSetSummary.
+        The `OCID`__ of the virtual cloud network (VCN) the export set is in.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The vcn_id of this ExportSetSummary.
+        :rtype: str
+        """
+        return self._vcn_id
+
+    @vcn_id.setter
+    def vcn_id(self, vcn_id):
+        """
+        Sets the vcn_id of this ExportSetSummary.
+        The `OCID`__ of the virtual cloud network (VCN) the export set is in.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param vcn_id: The vcn_id of this ExportSetSummary.
+        :type: str
+        """
+        self._vcn_id = vcn_id
+
+    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

oci/file_storage/models/export_summary.py

@@ -0,0 +1,343 @@
+# 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 ExportSummary(object):
+    """
+    Summary information for an export.
+    """
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSummary.
+    #: This constant has a value of "CREATING"
+    LIFECYCLE_STATE_CREATING = "CREATING"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSummary.
+    #: This constant has a value of "ACTIVE"
+    LIFECYCLE_STATE_ACTIVE = "ACTIVE"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSummary.
+    #: This constant has a value of "DELETING"
+    LIFECYCLE_STATE_DELETING = "DELETING"
+
+    #: A constant which can be used with the lifecycle_state property of a ExportSummary.
+    #: This constant has a value of "DELETED"
+    LIFECYCLE_STATE_DELETED = "DELETED"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ExportSummary object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param export_set_id:
+            The value to assign to the export_set_id property of this ExportSummary.
+        :type export_set_id: str
+
+        :param file_system_id:
+            The value to assign to the file_system_id property of this ExportSummary.
+        :type file_system_id: str
+
+        :param id:
+            The value to assign to the id property of this ExportSummary.
+        :type id: str
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this ExportSummary.
+            Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param path:
+            The value to assign to the path property of this ExportSummary.
+        :type path: str
+
+        :param is_idmap_groups_for_sys_auth:
+            The value to assign to the is_idmap_groups_for_sys_auth property of this ExportSummary.
+        :type is_idmap_groups_for_sys_auth: bool
+
+        :param time_created:
+            The value to assign to the time_created property of this ExportSummary.
+        :type time_created: datetime
+
+        :param locks:
+            The value to assign to the locks property of this ExportSummary.
+        :type locks: list[oci.file_storage.models.ResourceLock]
+
+        """
+        self.swagger_types = {
+            'export_set_id': 'str',
+            'file_system_id': 'str',
+            'id': 'str',
+            'lifecycle_state': 'str',
+            'path': 'str',
+            'is_idmap_groups_for_sys_auth': 'bool',
+            'time_created': 'datetime',
+            'locks': 'list[ResourceLock]'
+        }
+
+        self.attribute_map = {
+            'export_set_id': 'exportSetId',
+            'file_system_id': 'fileSystemId',
+            'id': 'id',
+            'lifecycle_state': 'lifecycleState',
+            'path': 'path',
+            'is_idmap_groups_for_sys_auth': 'isIdmapGroupsForSysAuth',
+            'time_created': 'timeCreated',
+            'locks': 'locks'
+        }
+
+        self._export_set_id = None
+        self._file_system_id = None
+        self._id = None
+        self._lifecycle_state = None
+        self._path = None
+        self._is_idmap_groups_for_sys_auth = None
+        self._time_created = None
+        self._locks = None
+
+    @property
+    def export_set_id(self):
+        """
+        **[Required]** Gets the export_set_id of this ExportSummary.
+        The `OCID`__ of this export's export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The export_set_id of this ExportSummary.
+        :rtype: str
+        """
+        return self._export_set_id
+
+    @export_set_id.setter
+    def export_set_id(self, export_set_id):
+        """
+        Sets the export_set_id of this ExportSummary.
+        The `OCID`__ of this export's export set.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param export_set_id: The export_set_id of this ExportSummary.
+        :type: str
+        """
+        self._export_set_id = export_set_id
+
+    @property
+    def file_system_id(self):
+        """
+        **[Required]** Gets the file_system_id of this ExportSummary.
+        The `OCID`__ of this export's file system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The file_system_id of this ExportSummary.
+        :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 ExportSummary.
+        The `OCID`__ of this export's file system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param file_system_id: The file_system_id of this ExportSummary.
+        :type: str
+        """
+        self._file_system_id = file_system_id
+
+    @property
+    def id(self):
+        """
+        **[Required]** Gets the id of this ExportSummary.
+        The `OCID`__ of this export.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The id of this ExportSummary.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """
+        Sets the id of this ExportSummary.
+        The `OCID`__ of this export.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param id: The id of this ExportSummary.
+        :type: str
+        """
+        self._id = id
+
+    @property
+    def lifecycle_state(self):
+        """
+        **[Required]** Gets the lifecycle_state of this ExportSummary.
+        The current state of this export.
+
+        Allowed values for this property are: "CREATING", "ACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The lifecycle_state of this ExportSummary.
+        :rtype: str
+        """
+        return self._lifecycle_state
+
+    @lifecycle_state.setter
+    def lifecycle_state(self, lifecycle_state):
+        """
+        Sets the lifecycle_state of this ExportSummary.
+        The current state of this export.
+
+
+        :param lifecycle_state: The lifecycle_state of this ExportSummary.
+        :type: str
+        """
+        allowed_values = ["CREATING", "ACTIVE", "DELETING", "DELETED"]
+        if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
+            lifecycle_state = 'UNKNOWN_ENUM_VALUE'
+        self._lifecycle_state = lifecycle_state
+
+    @property
+    def path(self):
+        """
+        **[Required]** Gets the path of this ExportSummary.
+        Path used to access the associated file system.
+
+        Avoid entering confidential information.
+
+        Example: `/mediafiles`
+
+
+        :return: The path of this ExportSummary.
+        :rtype: str
+        """
+        return self._path
+
+    @path.setter
+    def path(self, path):
+        """
+        Sets the path of this ExportSummary.
+        Path used to access the associated file system.
+
+        Avoid entering confidential information.
+
+        Example: `/mediafiles`
+
+
+        :param path: The path of this ExportSummary.
+        :type: str
+        """
+        self._path = path
+
+    @property
+    def is_idmap_groups_for_sys_auth(self):
+        """
+        Gets the is_idmap_groups_for_sys_auth of this ExportSummary.
+        Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
+
+
+        :return: The is_idmap_groups_for_sys_auth of this ExportSummary.
+        :rtype: bool
+        """
+        return self._is_idmap_groups_for_sys_auth
+
+    @is_idmap_groups_for_sys_auth.setter
+    def is_idmap_groups_for_sys_auth(self, is_idmap_groups_for_sys_auth):
+        """
+        Sets the is_idmap_groups_for_sys_auth of this ExportSummary.
+        Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
+
+
+        :param is_idmap_groups_for_sys_auth: The is_idmap_groups_for_sys_auth of this ExportSummary.
+        :type: bool
+        """
+        self._is_idmap_groups_for_sys_auth = is_idmap_groups_for_sys_auth
+
+    @property
+    def time_created(self):
+        """
+        **[Required]** Gets the time_created of this ExportSummary.
+        The date and time the export 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 ExportSummary.
+        :rtype: datetime
+        """
+        return self._time_created
+
+    @time_created.setter
+    def time_created(self, time_created):
+        """
+        Sets the time_created of this ExportSummary.
+        The date and time the export 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 ExportSummary.
+        :type: datetime
+        """
+        self._time_created = time_created
+
+    @property
+    def locks(self):
+        """
+        Gets the locks of this ExportSummary.
+        Locks associated with this resource.
+
+
+        :return: The locks of this ExportSummary.
+        :rtype: list[oci.file_storage.models.ResourceLock]
+        """
+        return self._locks
+
+    @locks.setter
+    def locks(self, locks):
+        """
+        Sets the locks of this ExportSummary.
+        Locks associated with this resource.
+
+
+        :param locks: The locks of this ExportSummary.
+        :type: list[oci.file_storage.models.ResourceLock]
+        """
+        self._locks = locks
+
+    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