ClusterClientCompositeOperations

class oci.ocvp.ClusterClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ClusterClient 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 ClusterClientCompositeOperations object
create_cluster_and_wait_for_state(…[, …])	Calls create_cluster() and waits for the WorkRequest to enter the given state(s).
delete_cluster_and_wait_for_state(cluster_id)	Calls delete_cluster() and waits for the WorkRequest to enter the given state(s).
update_cluster_and_wait_for_state(…[, …])	Calls update_cluster() and waits for the Cluster acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new ClusterClientCompositeOperations object

Parameters:client (ClusterClient) – The service client which will be wrapped by this object

create_cluster_and_wait_for_state(create_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_cluster() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_cluster_details (oci.ocvp.models.CreateClusterDetails) – (required) Details for the Cluster.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_cluster()
• 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_cluster_and_wait_for_state(cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_cluster() and waits for the WorkRequest to enter the given state(s).

Parameters:

• cluster_id (str) –

  (required) The OCID of the Cluster.

• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for status
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_cluster()
• 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_cluster_and_wait_for_state(cluster_id, update_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_cluster() and waits for the Cluster acted upon to enter the given state(s).

Parameters:

• cluster_id (str) –

  (required) The OCID of the Cluster.

• update_cluster_details (oci.ocvp.models.UpdateClusterDetails) – (required) The information to be updated.
• 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_cluster()
• 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