EkmClientCompositeOperations

class oci.key_management.EkmClientCompositeOperations(client, **kwargs)

This class provides a wrapper around EkmClient 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

Methods

__init__(client, **kwargs) Creates a new EkmClientCompositeOperations object
create_ekms_private_endpoint_and_wait_for_state(…) Calls create_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).
delete_ekms_private_endpoint_and_wait_for_state(…) Calls delete_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).
update_ekms_private_endpoint_and_wait_for_state(…) Calls update_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new EkmClientCompositeOperations object

Parameters:client (EkmClient) – The service client which will be wrapped by this object
create_ekms_private_endpoint_and_wait_for_state(create_ekms_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).

Parameters:
  • create_ekms_private_endpoint_details (oci.key_management.models.CreateEkmsPrivateEndpointDetails) – (required) The information used to create EKMS private endpoint.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_ekms_private_endpoint()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the 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
delete_ekms_private_endpoint_and_wait_for_state(ekms_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).

Parameters:
  • ekms_private_endpoint_id (str) – (required) Unique EKMS private endpoint identifier.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_ekms_private_endpoint()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the 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
update_ekms_private_endpoint_and_wait_for_state(ekms_private_endpoint_id, update_ekms_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_ekms_private_endpoint() and waits for the EkmsPrivateEndpoint acted upon to enter the given state(s).

Parameters:
  • ekms_private_endpoint_id (str) – (required) Unique EKMS private endpoint identifier.
  • update_ekms_private_endpoint_details (oci.key_management.models.UpdateEkmsPrivateEndpointDetails) – (required) The information to be updated in EKMS private endpoint
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_ekms_private_endpoint()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the 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