oci 2.125.2__py3-none-any.whl → 2.126.0__py3-none-any.whl

oci/cluster_placement_groups/cluster_placement_groups_cp_client_composite_operations.py

@@ -0,0 +1,238 @@
+# 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: 20230801
+
+import oci  # noqa: F401
+from oci.util import WAIT_RESOURCE_NOT_FOUND  # noqa: F401
+
+
+class ClusterPlacementGroupsCPClientCompositeOperations(object):
+    """
+    This class provides a wrapper around :py:class:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient` and offers convenience methods
+    for operations that would otherwise need to be chained together. For example, instead of performing an action
+    on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource
+    to enter a given state, you can call a single method in this class to accomplish the same functionality
+    """
+
+    def __init__(self, client, **kwargs):
+        """
+        Creates a new ClusterPlacementGroupsCPClientCompositeOperations object
+
+        :param ClusterPlacementGroupsCPClient client:
+            The service client which will be wrapped by this object
+        """
+        self.client = client
+
+    def activate_cluster_placement_group_and_wait_for_state(self, cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.activate_cluster_placement_group` and waits for the :py:class:`~oci.cluster_placement_groups.models.ClusterPlacementGroup` acted upon
+        to enter the given state(s).
+
+        :param str cluster_placement_group_id: (required)
+            A unique cluster placement group identifier.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.cluster_placement_groups.models.ClusterPlacementGroup.lifecycle_state`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.activate_cluster_placement_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.activate_cluster_placement_group(cluster_placement_group_id, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        cluster_placement_group_id = operation_result.data.id
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_cluster_placement_group(cluster_placement_group_id),  # noqa: F821
+                evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except (NameError, TypeError) as e:
+            if not e.args:
+                e.args = ('',)
+            e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', )
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
+    def create_cluster_placement_group_and_wait_for_state(self, create_cluster_placement_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.create_cluster_placement_group` and waits for the :py:class:`~oci.cluster_placement_groups.models.WorkRequest`
+        to enter the given state(s).
+
+        :param oci.cluster_placement_groups.models.CreateClusterPlacementGroupDetails create_cluster_placement_group_details: (required)
+            The details for creating the new cluster placement group.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.cluster_placement_groups.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.create_cluster_placement_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.create_cluster_placement_group(create_cluster_placement_group_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
+    def deactivate_cluster_placement_group_and_wait_for_state(self, cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.deactivate_cluster_placement_group` and waits for the :py:class:`~oci.cluster_placement_groups.models.ClusterPlacementGroup` acted upon
+        to enter the given state(s).
+
+        :param str cluster_placement_group_id: (required)
+            A unique cluster placement group identifier.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.cluster_placement_groups.models.ClusterPlacementGroup.lifecycle_state`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.deactivate_cluster_placement_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.deactivate_cluster_placement_group(cluster_placement_group_id, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        cluster_placement_group_id = operation_result.data.id
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_cluster_placement_group(cluster_placement_group_id),  # noqa: F821
+                evaluate_response=lambda r: getattr(r.data, 'lifecycle_state') and getattr(r.data, 'lifecycle_state').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except (NameError, TypeError) as e:
+            if not e.args:
+                e.args = ('',)
+            e.args = e.args + ('This composite operation is currently not supported in the SDK. Please use the operation from the service client and use waiters as an alternative. For more information on waiters, visit: "https://docs.oracle.com/en-us/iaas/tools/python/latest/api/waiters.html"', )
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
+    def delete_cluster_placement_group_and_wait_for_state(self, cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.delete_cluster_placement_group` and waits for the :py:class:`~oci.cluster_placement_groups.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str cluster_placement_group_id: (required)
+            A unique cluster placement group identifier.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.cluster_placement_groups.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.delete_cluster_placement_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = None
+        try:
+            operation_result = self.client.delete_cluster_placement_group(cluster_placement_group_id, **operation_kwargs)
+        except oci.exceptions.ServiceError as e:
+            if e.status == 404:
+                return WAIT_RESOURCE_NOT_FOUND
+            else:
+                raise e
+
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)
+
+    def update_cluster_placement_group_and_wait_for_state(self, cluster_placement_group_id, update_cluster_placement_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
+        """
+        Calls :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.update_cluster_placement_group` and waits for the :py:class:`~oci.cluster_placement_groups.models.WorkRequest`
+        to enter the given state(s).
+
+        :param str cluster_placement_group_id: (required)
+            A unique cluster placement group identifier.
+
+        :param oci.cluster_placement_groups.models.UpdateClusterPlacementGroupDetails update_cluster_placement_group_details: (required)
+            The details of the cluster placement group to update.
+
+        :param list[str] wait_for_states:
+            An array of states to wait on. These should be valid values for :py:attr:`~oci.cluster_placement_groups.models.WorkRequest.status`
+
+        :param dict operation_kwargs:
+            A dictionary of keyword arguments to pass to :py:func:`~oci.cluster_placement_groups.ClusterPlacementGroupsCPClient.update_cluster_placement_group`
+
+        :param dict waiter_kwargs:
+            A dictionary of keyword arguments to pass to the :py:func:`oci.wait_until` function. For example, you could pass ``max_interval_seconds`` or ``max_interval_seconds``
+            as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
+        """
+        operation_result = self.client.update_cluster_placement_group(cluster_placement_group_id, update_cluster_placement_group_details, **operation_kwargs)
+        if not wait_for_states:
+            return operation_result
+        lowered_wait_for_states = [w.lower() for w in wait_for_states]
+        if 'opc-work-request-id' not in operation_result.headers:
+            return operation_result
+        wait_for_resource_id = operation_result.headers['opc-work-request-id']
+
+        try:
+            waiter_result = oci.wait_until(
+                self.client,
+                self.client.get_work_request(wait_for_resource_id),
+                evaluate_response=lambda r: getattr(r.data, 'status') and getattr(r.data, 'status').lower() in lowered_wait_for_states,
+                **waiter_kwargs
+            )
+            result_to_return = waiter_result
+
+            return result_to_return
+        except Exception as e:
+            raise oci.exceptions.CompositeOperationError(partial_results=[operation_result], cause=e)

oci/cluster_placement_groups/models/__init__.py

@@ -0,0 +1,46 @@
+# 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: 20230801
+
+from __future__ import absolute_import
+
+from .capabilities_collection import CapabilitiesCollection
+from .capability_details import CapabilityDetails
+from .change_cluster_placement_group_compartment_details import ChangeClusterPlacementGroupCompartmentDetails
+from .cluster_placement_group import ClusterPlacementGroup
+from .cluster_placement_group_collection import ClusterPlacementGroupCollection
+from .cluster_placement_group_summary import ClusterPlacementGroupSummary
+from .create_cluster_placement_group_details import CreateClusterPlacementGroupDetails
+from .placement_instruction_details import PlacementInstructionDetails
+from .update_cluster_placement_group_details import UpdateClusterPlacementGroupDetails
+from .work_request import WorkRequest
+from .work_request_error import WorkRequestError
+from .work_request_error_collection import WorkRequestErrorCollection
+from .work_request_log_entry import WorkRequestLogEntry
+from .work_request_log_entry_collection import WorkRequestLogEntryCollection
+from .work_request_resource import WorkRequestResource
+from .work_request_summary import WorkRequestSummary
+from .work_request_summary_collection import WorkRequestSummaryCollection
+
+# Maps type names to classes for cluster_placement_groups services.
+cluster_placement_groups_type_mapping = {
+    "CapabilitiesCollection": CapabilitiesCollection,
+    "CapabilityDetails": CapabilityDetails,
+    "ChangeClusterPlacementGroupCompartmentDetails": ChangeClusterPlacementGroupCompartmentDetails,
+    "ClusterPlacementGroup": ClusterPlacementGroup,
+    "ClusterPlacementGroupCollection": ClusterPlacementGroupCollection,
+    "ClusterPlacementGroupSummary": ClusterPlacementGroupSummary,
+    "CreateClusterPlacementGroupDetails": CreateClusterPlacementGroupDetails,
+    "PlacementInstructionDetails": PlacementInstructionDetails,
+    "UpdateClusterPlacementGroupDetails": UpdateClusterPlacementGroupDetails,
+    "WorkRequest": WorkRequest,
+    "WorkRequestError": WorkRequestError,
+    "WorkRequestErrorCollection": WorkRequestErrorCollection,
+    "WorkRequestLogEntry": WorkRequestLogEntry,
+    "WorkRequestLogEntryCollection": WorkRequestLogEntryCollection,
+    "WorkRequestResource": WorkRequestResource,
+    "WorkRequestSummary": WorkRequestSummary,
+    "WorkRequestSummaryCollection": WorkRequestSummaryCollection
+}

oci/cluster_placement_groups/models/capabilities_collection.py

@@ -0,0 +1,72 @@
+# 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: 20230801
+
+
+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 CapabilitiesCollection(object):
+    """
+    A list of resources that you can create in a cluster placement group.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CapabilitiesCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this CapabilitiesCollection.
+        :type items: list[oci.cluster_placement_groups.models.CapabilityDetails]
+
+        """
+        self.swagger_types = {
+            'items': 'list[CapabilityDetails]'
+        }
+
+        self.attribute_map = {
+            'items': 'items'
+        }
+
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this CapabilitiesCollection.
+        The supported resources.
+
+
+        :return: The items of this CapabilitiesCollection.
+        :rtype: list[oci.cluster_placement_groups.models.CapabilityDetails]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this CapabilitiesCollection.
+        The supported resources.
+
+
+        :param items: The items of this CapabilitiesCollection.
+        :type: list[oci.cluster_placement_groups.models.CapabilityDetails]
+        """
+        self._items = items
+
+    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/cluster_placement_groups/models/capability_details.py

@@ -0,0 +1,103 @@
+# 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: 20230801
+
+
+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 CapabilityDetails(object):
+    """
+    Details about the supported type of resource.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new CapabilityDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param service:
+            The value to assign to the service property of this CapabilityDetails.
+        :type service: str
+
+        :param name:
+            The value to assign to the name property of this CapabilityDetails.
+        :type name: str
+
+        """
+        self.swagger_types = {
+            'service': 'str',
+            'name': 'str'
+        }
+
+        self.attribute_map = {
+            'service': 'service',
+            'name': 'name'
+        }
+
+        self._service = None
+        self._name = None
+
+    @property
+    def service(self):
+        """
+        **[Required]** Gets the service of this CapabilityDetails.
+        The service that the resource is part of.
+
+
+        :return: The service of this CapabilityDetails.
+        :rtype: str
+        """
+        return self._service
+
+    @service.setter
+    def service(self, service):
+        """
+        Sets the service of this CapabilityDetails.
+        The service that the resource is part of.
+
+
+        :param service: The service of this CapabilityDetails.
+        :type: str
+        """
+        self._service = service
+
+    @property
+    def name(self):
+        """
+        **[Required]** Gets the name of this CapabilityDetails.
+        The type of resource.
+
+
+        :return: The name of this CapabilityDetails.
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """
+        Sets the name of this CapabilityDetails.
+        The type of resource.
+
+
+        :param name: The name of this CapabilityDetails.
+        :type: str
+        """
+        self._name = name
+
+    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/{application_migration/models/change_compartment_details.py → cluster_placement_groups/models/change_cluster_placement_group_compartment_details.py}

@@ -2,7 +2,7 @@
 # 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: 20191031
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20230801
 
 
 from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
@@ -10,18 +10,18 @@ from oci.decorators import init_model_state_from_kwargs
 
 
 @init_model_state_from_kwargs
-class ChangeCompartmentDetails(object):
+class ChangeClusterPlacementGroupCompartmentDetails(object):
     """
-    Moves the resource to the specified compartment.
+    The information to update.
     """
 
     def __init__(self, **kwargs):
         """
-        Initializes a new ChangeCompartmentDetails object with values from keyword arguments.
+        Initializes a new ChangeClusterPlacementGroupCompartmentDetails object with values from keyword arguments.
         The following keyword arguments are supported (corresponding to the getters/setters of this class):
 
         :param compartment_id:
-            The value to assign to the compartment_id property of this ChangeCompartmentDetails.
+            The value to assign to the compartment_id property of this ChangeClusterPlacementGroupCompartmentDetails.
         :type compartment_id: str
 
         """
@@ -38,14 +38,14 @@ class ChangeCompartmentDetails(object):
     @property
     def compartment_id(self):
         """
-        **[Required]** Gets the compartment_id of this ChangeCompartmentDetails.
+        **[Required]** Gets the compartment_id of this ChangeClusterPlacementGroupCompartmentDetails.
         The `OCID`__ of the compartment
-        to move the resource to.
+        into which the resource should be moved.
 
         __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
-        :return: The compartment_id of this ChangeCompartmentDetails.
+        :return: The compartment_id of this ChangeClusterPlacementGroupCompartmentDetails.
         :rtype: str
         """
         return self._compartment_id
@@ -53,14 +53,14 @@ class ChangeCompartmentDetails(object):
     @compartment_id.setter
     def compartment_id(self, compartment_id):
         """
-        Sets the compartment_id of this ChangeCompartmentDetails.
+        Sets the compartment_id of this ChangeClusterPlacementGroupCompartmentDetails.
         The `OCID`__ of the compartment
-        to move the resource to.
+        into which the resource should be moved.
 
         __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
-        :param compartment_id: The compartment_id of this ChangeCompartmentDetails.
+        :param compartment_id: The compartment_id of this ChangeClusterPlacementGroupCompartmentDetails.
         :type: str
         """
         self._compartment_id = compartment_id