oci 2.122.0__py3-none-any.whl → 2.123.0__py3-none-any.whl

oci/core/models/launch_attach_volume_details.py

@@ -0,0 +1,279 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20160918
+
+
+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 LaunchAttachVolumeDetails(object):
+    """
+    The details of the volume to attach.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LaunchAttachVolumeDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.core.models.LaunchAttachIScsiVolumeDetails`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param device:
+            The value to assign to the device property of this LaunchAttachVolumeDetails.
+        :type device: str
+
+        :param display_name:
+            The value to assign to the display_name property of this LaunchAttachVolumeDetails.
+        :type display_name: str
+
+        :param is_read_only:
+            The value to assign to the is_read_only property of this LaunchAttachVolumeDetails.
+        :type is_read_only: bool
+
+        :param is_shareable:
+            The value to assign to the is_shareable property of this LaunchAttachVolumeDetails.
+        :type is_shareable: bool
+
+        :param type:
+            The value to assign to the type property of this LaunchAttachVolumeDetails.
+        :type type: str
+
+        :param volume_id:
+            The value to assign to the volume_id property of this LaunchAttachVolumeDetails.
+        :type volume_id: str
+
+        :param launch_create_volume_details:
+            The value to assign to the launch_create_volume_details property of this LaunchAttachVolumeDetails.
+        :type launch_create_volume_details: oci.core.models.LaunchCreateVolumeDetails
+
+        """
+        self.swagger_types = {
+            'device': 'str',
+            'display_name': 'str',
+            'is_read_only': 'bool',
+            'is_shareable': 'bool',
+            'type': 'str',
+            'volume_id': 'str',
+            'launch_create_volume_details': 'LaunchCreateVolumeDetails'
+        }
+
+        self.attribute_map = {
+            'device': 'device',
+            'display_name': 'displayName',
+            'is_read_only': 'isReadOnly',
+            'is_shareable': 'isShareable',
+            'type': 'type',
+            'volume_id': 'volumeId',
+            'launch_create_volume_details': 'launchCreateVolumeDetails'
+        }
+
+        self._device = None
+        self._display_name = None
+        self._is_read_only = None
+        self._is_shareable = None
+        self._type = None
+        self._volume_id = None
+        self._launch_create_volume_details = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['type']
+
+        if type == 'iscsi':
+            return 'LaunchAttachIScsiVolumeDetails'
+        else:
+            return 'LaunchAttachVolumeDetails'
+
+    @property
+    def device(self):
+        """
+        Gets the device of this LaunchAttachVolumeDetails.
+        The device name. To retrieve a list of devices for a given instance, see :func:`list_instance_devices`.
+
+
+        :return: The device of this LaunchAttachVolumeDetails.
+        :rtype: str
+        """
+        return self._device
+
+    @device.setter
+    def device(self, device):
+        """
+        Sets the device of this LaunchAttachVolumeDetails.
+        The device name. To retrieve a list of devices for a given instance, see :func:`list_instance_devices`.
+
+
+        :param device: The device of this LaunchAttachVolumeDetails.
+        :type: str
+        """
+        self._device = device
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this LaunchAttachVolumeDetails.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+        Avoid entering confidential information.
+
+
+        :return: The display_name of this LaunchAttachVolumeDetails.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this LaunchAttachVolumeDetails.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+        Avoid entering confidential information.
+
+
+        :param display_name: The display_name of this LaunchAttachVolumeDetails.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def is_read_only(self):
+        """
+        Gets the is_read_only of this LaunchAttachVolumeDetails.
+        Whether the attachment was created in read-only mode.
+
+
+        :return: The is_read_only of this LaunchAttachVolumeDetails.
+        :rtype: bool
+        """
+        return self._is_read_only
+
+    @is_read_only.setter
+    def is_read_only(self, is_read_only):
+        """
+        Sets the is_read_only of this LaunchAttachVolumeDetails.
+        Whether the attachment was created in read-only mode.
+
+
+        :param is_read_only: The is_read_only of this LaunchAttachVolumeDetails.
+        :type: bool
+        """
+        self._is_read_only = is_read_only
+
+    @property
+    def is_shareable(self):
+        """
+        Gets the is_shareable of this LaunchAttachVolumeDetails.
+        Whether the attachment should be created in shareable mode. If an attachment
+        is created in shareable mode, then other instances can attach the same volume, provided
+        that they also create their attachments in shareable mode. Only certain volume types can
+        be attached in shareable mode. Defaults to false if not specified.
+
+
+        :return: The is_shareable of this LaunchAttachVolumeDetails.
+        :rtype: bool
+        """
+        return self._is_shareable
+
+    @is_shareable.setter
+    def is_shareable(self, is_shareable):
+        """
+        Sets the is_shareable of this LaunchAttachVolumeDetails.
+        Whether the attachment should be created in shareable mode. If an attachment
+        is created in shareable mode, then other instances can attach the same volume, provided
+        that they also create their attachments in shareable mode. Only certain volume types can
+        be attached in shareable mode. Defaults to false if not specified.
+
+
+        :param is_shareable: The is_shareable of this LaunchAttachVolumeDetails.
+        :type: bool
+        """
+        self._is_shareable = is_shareable
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this LaunchAttachVolumeDetails.
+        The type of volume. Currently, the only supported value is \"iscsi\".
+
+
+        :return: The type of this LaunchAttachVolumeDetails.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this LaunchAttachVolumeDetails.
+        The type of volume. Currently, the only supported value is \"iscsi\".
+
+
+        :param type: The type of this LaunchAttachVolumeDetails.
+        :type: str
+        """
+        self._type = type
+
+    @property
+    def volume_id(self):
+        """
+        Gets the volume_id of this LaunchAttachVolumeDetails.
+        The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
+
+
+        :return: The volume_id of this LaunchAttachVolumeDetails.
+        :rtype: str
+        """
+        return self._volume_id
+
+    @volume_id.setter
+    def volume_id(self, volume_id):
+        """
+        Sets the volume_id of this LaunchAttachVolumeDetails.
+        The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
+
+
+        :param volume_id: The volume_id of this LaunchAttachVolumeDetails.
+        :type: str
+        """
+        self._volume_id = volume_id
+
+    @property
+    def launch_create_volume_details(self):
+        """
+        Gets the launch_create_volume_details of this LaunchAttachVolumeDetails.
+
+        :return: The launch_create_volume_details of this LaunchAttachVolumeDetails.
+        :rtype: oci.core.models.LaunchCreateVolumeDetails
+        """
+        return self._launch_create_volume_details
+
+    @launch_create_volume_details.setter
+    def launch_create_volume_details(self, launch_create_volume_details):
+        """
+        Sets the launch_create_volume_details of this LaunchAttachVolumeDetails.
+
+        :param launch_create_volume_details: The launch_create_volume_details of this LaunchAttachVolumeDetails.
+        :type: oci.core.models.LaunchCreateVolumeDetails
+        """
+        self._launch_create_volume_details = launch_create_volume_details
+
+    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/core/models/launch_create_volume_details.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20160918
+
+
+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 LaunchCreateVolumeDetails(object):
+    """
+    Define a volume that will be created and attached or attached to an instance on creation.
+    """
+
+    #: A constant which can be used with the volume_creation_type property of a LaunchCreateVolumeDetails.
+    #: This constant has a value of "ATTRIBUTES"
+    VOLUME_CREATION_TYPE_ATTRIBUTES = "ATTRIBUTES"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LaunchCreateVolumeDetails object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.core.models.LaunchCreateVolumeFromAttributes`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param volume_creation_type:
+            The value to assign to the volume_creation_type property of this LaunchCreateVolumeDetails.
+            Allowed values for this property are: "ATTRIBUTES"
+        :type volume_creation_type: str
+
+        """
+        self.swagger_types = {
+            'volume_creation_type': 'str'
+        }
+
+        self.attribute_map = {
+            'volume_creation_type': 'volumeCreationType'
+        }
+
+        self._volume_creation_type = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['volumeCreationType']
+
+        if type == 'ATTRIBUTES':
+            return 'LaunchCreateVolumeFromAttributes'
+        else:
+            return 'LaunchCreateVolumeDetails'
+
+    @property
+    def volume_creation_type(self):
+        """
+        **[Required]** Gets the volume_creation_type of this LaunchCreateVolumeDetails.
+        Specifies the method for volume creation.
+
+        Allowed values for this property are: "ATTRIBUTES"
+
+
+        :return: The volume_creation_type of this LaunchCreateVolumeDetails.
+        :rtype: str
+        """
+        return self._volume_creation_type
+
+    @volume_creation_type.setter
+    def volume_creation_type(self, volume_creation_type):
+        """
+        Sets the volume_creation_type of this LaunchCreateVolumeDetails.
+        Specifies the method for volume creation.
+
+
+        :param volume_creation_type: The volume_creation_type of this LaunchCreateVolumeDetails.
+        :type: str
+        """
+        allowed_values = ["ATTRIBUTES"]
+        if not value_allowed_none_or_none_sentinel(volume_creation_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `volume_creation_type`, must be None or one of {allowed_values}"
+            )
+        self._volume_creation_type = volume_creation_type
+
+    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/core/models/launch_create_volume_from_attributes.py

@@ -0,0 +1,240 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, 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: 20160918
+
+from .launch_create_volume_details import LaunchCreateVolumeDetails
+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 LaunchCreateVolumeFromAttributes(LaunchCreateVolumeDetails):
+    """
+    The details of the volume to create for CreateVolume operation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new LaunchCreateVolumeFromAttributes object with values from keyword arguments. The default value of the :py:attr:`~oci.core.models.LaunchCreateVolumeFromAttributes.volume_creation_type` attribute
+        of this class is ``ATTRIBUTES`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param volume_creation_type:
+            The value to assign to the volume_creation_type property of this LaunchCreateVolumeFromAttributes.
+            Allowed values for this property are: "ATTRIBUTES"
+        :type volume_creation_type: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this LaunchCreateVolumeFromAttributes.
+        :type compartment_id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this LaunchCreateVolumeFromAttributes.
+        :type display_name: str
+
+        :param kms_key_id:
+            The value to assign to the kms_key_id property of this LaunchCreateVolumeFromAttributes.
+        :type kms_key_id: str
+
+        :param vpus_per_gb:
+            The value to assign to the vpus_per_gb property of this LaunchCreateVolumeFromAttributes.
+        :type vpus_per_gb: int
+
+        :param size_in_gbs:
+            The value to assign to the size_in_gbs property of this LaunchCreateVolumeFromAttributes.
+        :type size_in_gbs: int
+
+        """
+        self.swagger_types = {
+            'volume_creation_type': 'str',
+            'compartment_id': 'str',
+            'display_name': 'str',
+            'kms_key_id': 'str',
+            'vpus_per_gb': 'int',
+            'size_in_gbs': 'int'
+        }
+
+        self.attribute_map = {
+            'volume_creation_type': 'volumeCreationType',
+            'compartment_id': 'compartmentId',
+            'display_name': 'displayName',
+            'kms_key_id': 'kmsKeyId',
+            'vpus_per_gb': 'vpusPerGB',
+            'size_in_gbs': 'sizeInGBs'
+        }
+
+        self._volume_creation_type = None
+        self._compartment_id = None
+        self._display_name = None
+        self._kms_key_id = None
+        self._vpus_per_gb = None
+        self._size_in_gbs = None
+        self._volume_creation_type = 'ATTRIBUTES'
+
+    @property
+    def compartment_id(self):
+        """
+        Gets the compartment_id of this LaunchCreateVolumeFromAttributes.
+        The OCID of the compartment that contains the volume. If not provided,
+        it will be inherited from the instance.
+
+
+        :return: The compartment_id of this LaunchCreateVolumeFromAttributes.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this LaunchCreateVolumeFromAttributes.
+        The OCID of the compartment that contains the volume. If not provided,
+        it will be inherited from the instance.
+
+
+        :param compartment_id: The compartment_id of this LaunchCreateVolumeFromAttributes.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    @property
+    def display_name(self):
+        """
+        Gets the display_name of this LaunchCreateVolumeFromAttributes.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+        Avoid entering confidential information.
+
+
+        :return: The display_name of this LaunchCreateVolumeFromAttributes.
+        :rtype: str
+        """
+        return self._display_name
+
+    @display_name.setter
+    def display_name(self, display_name):
+        """
+        Sets the display_name of this LaunchCreateVolumeFromAttributes.
+        A user-friendly name. Does not have to be unique, and it's changeable.
+        Avoid entering confidential information.
+
+
+        :param display_name: The display_name of this LaunchCreateVolumeFromAttributes.
+        :type: str
+        """
+        self._display_name = display_name
+
+    @property
+    def kms_key_id(self):
+        """
+        Gets the kms_key_id of this LaunchCreateVolumeFromAttributes.
+        The OCID of the Vault service key to assign as the master encryption key
+        for the volume.
+
+
+        :return: The kms_key_id of this LaunchCreateVolumeFromAttributes.
+        :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 LaunchCreateVolumeFromAttributes.
+        The OCID of the Vault service key to assign as the master encryption key
+        for the volume.
+
+
+        :param kms_key_id: The kms_key_id of this LaunchCreateVolumeFromAttributes.
+        :type: str
+        """
+        self._kms_key_id = kms_key_id
+
+    @property
+    def vpus_per_gb(self):
+        """
+        Gets the vpus_per_gb of this LaunchCreateVolumeFromAttributes.
+        The number of volume performance units (VPUs) that will be applied to this volume per GB,
+        representing the Block Volume service's elastic performance options.
+        See `Block Volume Performance Levels`__ for more information.
+
+        Allowed values:
+
+          * `0`: Represents Lower Cost option.
+
+          * `10`: Represents Balanced option.
+
+          * `20`: Represents Higher Performance option.
+
+          * `30`-`120`: Represents the Ultra High Performance option.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels
+
+
+        :return: The vpus_per_gb of this LaunchCreateVolumeFromAttributes.
+        :rtype: int
+        """
+        return self._vpus_per_gb
+
+    @vpus_per_gb.setter
+    def vpus_per_gb(self, vpus_per_gb):
+        """
+        Sets the vpus_per_gb of this LaunchCreateVolumeFromAttributes.
+        The number of volume performance units (VPUs) that will be applied to this volume per GB,
+        representing the Block Volume service's elastic performance options.
+        See `Block Volume Performance Levels`__ for more information.
+
+        Allowed values:
+
+          * `0`: Represents Lower Cost option.
+
+          * `10`: Represents Balanced option.
+
+          * `20`: Represents Higher Performance option.
+
+          * `30`-`120`: Represents the Ultra High Performance option.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels
+
+
+        :param vpus_per_gb: The vpus_per_gb of this LaunchCreateVolumeFromAttributes.
+        :type: int
+        """
+        self._vpus_per_gb = vpus_per_gb
+
+    @property
+    def size_in_gbs(self):
+        """
+        **[Required]** Gets the size_in_gbs of this LaunchCreateVolumeFromAttributes.
+        The size of the volume in GBs.
+
+
+        :return: The size_in_gbs of this LaunchCreateVolumeFromAttributes.
+        :rtype: int
+        """
+        return self._size_in_gbs
+
+    @size_in_gbs.setter
+    def size_in_gbs(self, size_in_gbs):
+        """
+        Sets the size_in_gbs of this LaunchCreateVolumeFromAttributes.
+        The size of the volume in GBs.
+
+
+        :param size_in_gbs: The size_in_gbs of this LaunchCreateVolumeFromAttributes.
+        :type: int
+        """
+        self._size_in_gbs = size_in_gbs
+
+    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/core/models/launch_instance_details.py

@@ -117,6 +117,10 @@ class LaunchInstanceDetails(object):
             The value to assign to the subnet_id property of this LaunchInstanceDetails.
         :type subnet_id: str
 
+        :param launch_volume_attachments:
+            The value to assign to the launch_volume_attachments property of this LaunchInstanceDetails.
+        :type launch_volume_attachments: list[oci.core.models.LaunchAttachVolumeDetails]
+
         :param is_pv_encryption_in_transit_enabled:
             The value to assign to the is_pv_encryption_in_transit_enabled property of this LaunchInstanceDetails.
         :type is_pv_encryption_in_transit_enabled: bool
@@ -155,6 +159,7 @@ class LaunchInstanceDetails(object):
             'shape_config': 'LaunchInstanceShapeConfigDetails',
             'source_details': 'InstanceSourceDetails',
             'subnet_id': 'str',
+            'launch_volume_attachments': 'list[LaunchAttachVolumeDetails]',
             'is_pv_encryption_in_transit_enabled': 'bool',
             'platform_config': 'LaunchInstancePlatformConfig',
             'instance_configuration_id': 'str'
@@ -185,6 +190,7 @@ class LaunchInstanceDetails(object):
             'shape_config': 'shapeConfig',
             'source_details': 'sourceDetails',
             'subnet_id': 'subnetId',
+            'launch_volume_attachments': 'launchVolumeAttachments',
             'is_pv_encryption_in_transit_enabled': 'isPvEncryptionInTransitEnabled',
             'platform_config': 'platformConfig',
             'instance_configuration_id': 'instanceConfigurationId'
@@ -214,6 +220,7 @@ class LaunchInstanceDetails(object):
         self._shape_config = None
         self._source_details = None
         self._subnet_id = None
+        self._launch_volume_attachments = None
         self._is_pv_encryption_in_transit_enabled = None
         self._platform_config = None
         self._instance_configuration_id = None
@@ -1022,6 +1029,30 @@ class LaunchInstanceDetails(object):
         """
         self._subnet_id = subnet_id
 
+    @property
+    def launch_volume_attachments(self):
+        """
+        Gets the launch_volume_attachments of this LaunchInstanceDetails.
+        Volume attachments to create as part of the launch instance operation.
+
+
+        :return: The launch_volume_attachments of this LaunchInstanceDetails.
+        :rtype: list[oci.core.models.LaunchAttachVolumeDetails]
+        """
+        return self._launch_volume_attachments
+
+    @launch_volume_attachments.setter
+    def launch_volume_attachments(self, launch_volume_attachments):
+        """
+        Sets the launch_volume_attachments of this LaunchInstanceDetails.
+        Volume attachments to create as part of the launch instance operation.
+
+
+        :param launch_volume_attachments: The launch_volume_attachments of this LaunchInstanceDetails.
+        :type: list[oci.core.models.LaunchAttachVolumeDetails]
+        """
+        self._launch_volume_attachments = launch_volume_attachments
+
     @property
     def is_pv_encryption_in_transit_enabled(self):
         """