| Server IP : 162.241.203.86 / Your IP : 216.73.216.101 Web Server : Apache System : Linux br1002.hostgator.com.br 5.14.0-687.36.1.el9_8.x86_64 #1 SMP PREEMPT_DYNAMIC Fri Aug 7 05:40:49 EDT 2026 x86_64 User : luxlic01 ( 6532) PHP Version : 8.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /lib/python3.9/site-packages/oci/key_management/ |
Upload File : |
# 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: release
import oci # noqa: F401
from oci.util import WAIT_RESOURCE_NOT_FOUND # noqa: F401
class KmsHsmClusterClientCompositeOperations(object):
"""
This class provides a wrapper around :py:class:`~oci.key_management.KmsHsmClusterClient` 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 KmsHsmClusterClientCompositeOperations object
:param KmsHsmClusterClient client:
The service client which will be wrapped by this object
"""
self.client = client
def cancel_hsm_cluster_deletion_and_wait_for_state(self, hsm_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.key_management.KmsHsmClusterClient.cancel_hsm_cluster_deletion` and waits for the :py:class:`~oci.key_management.models.HsmCluster` acted upon
to enter the given state(s).
:param str hsm_cluster_id: (required)
The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.HsmCluster.lifecycle_state`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsHsmClusterClient.cancel_hsm_cluster_deletion`
: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.cancel_hsm_cluster_deletion(hsm_cluster_id, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
hsm_cluster_id = operation_result.data.id
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_hsm_cluster(hsm_cluster_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_hsm_cluster_and_wait_for_state(self, create_hsm_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.key_management.KmsHsmClusterClient.create_hsm_cluster` and waits for the :py:class:`~oci.key_management.models.HsmCluster` acted upon
to enter the given state(s).
:param oci.key_management.models.CreateHsmClusterDetails create_hsm_cluster_details: (required)
Details for the new HsmCluster resource
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.HsmCluster.lifecycle_state`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsHsmClusterClient.create_hsm_cluster`
: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_hsm_cluster(create_hsm_cluster_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
hsm_cluster_id = operation_result.data.id
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_hsm_cluster(hsm_cluster_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 schedule_hsm_cluster_deletion_and_wait_for_state(self, hsm_cluster_id, schedule_hsm_cluster_deletion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.key_management.KmsHsmClusterClient.schedule_hsm_cluster_deletion` and waits for the :py:class:`~oci.key_management.models.HsmCluster` acted upon
to enter the given state(s).
:param str hsm_cluster_id: (required)
The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
:param oci.key_management.models.ScheduleHsmClusterDeletionDetails schedule_hsm_cluster_deletion_details: (required)
Details of ScheduleHsmClusterDeletionDetails
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.HsmCluster.lifecycle_state`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsHsmClusterClient.schedule_hsm_cluster_deletion`
: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.schedule_hsm_cluster_deletion(hsm_cluster_id, schedule_hsm_cluster_deletion_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
hsm_cluster_id = operation_result.data.id
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_hsm_cluster(hsm_cluster_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 update_hsm_cluster_and_wait_for_state(self, hsm_cluster_id, update_hsm_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={}):
"""
Calls :py:func:`~oci.key_management.KmsHsmClusterClient.update_hsm_cluster` and waits for the :py:class:`~oci.key_management.models.HsmCluster` acted upon
to enter the given state(s).
:param str hsm_cluster_id: (required)
The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
:param oci.key_management.models.UpdateHsmClusterDetails update_hsm_cluster_details: (required)
Details of the HsmCluster Resource
:param list[str] wait_for_states:
An array of states to wait on. These should be valid values for :py:attr:`~oci.key_management.models.HsmCluster.lifecycle_state`
:param dict operation_kwargs:
A dictionary of keyword arguments to pass to :py:func:`~oci.key_management.KmsHsmClusterClient.update_hsm_cluster`
: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_hsm_cluster(hsm_cluster_id, update_hsm_cluster_details, **operation_kwargs)
if not wait_for_states:
return operation_result
lowered_wait_for_states = [w.lower() for w in wait_for_states]
hsm_cluster_id = operation_result.data.id
try:
waiter_result = oci.wait_until(
self.client,
self.client.get_hsm_cluster(hsm_cluster_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)