ClusterPlacementGroupsCPClientCompositeOperations

class oci.cluster_placement_groups.ClusterPlacementGroupsCPClientCompositeOperations(client, **kwargs)

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

Methods:

__init__(client, **kwargs)

Creates a new ClusterPlacementGroupsCPClientCompositeOperations object

activate_cluster_placement_group_and_wait_for_state(...)

Calls activate_cluster_placement_group() and waits for the ClusterPlacementGroup acted upon to enter the given state(s).

create_cluster_placement_group_and_wait_for_state(...)

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

deactivate_cluster_placement_group_and_wait_for_state(...)

Calls deactivate_cluster_placement_group() and waits for the ClusterPlacementGroup acted upon to enter the given state(s).

delete_cluster_placement_group_and_wait_for_state(...)

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

update_cluster_placement_group_and_wait_for_state(...)

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

__init__(client, **kwargs)

Creates a new ClusterPlacementGroupsCPClientCompositeOperations object

Parameters

client (ClusterPlacementGroupsCPClient) – The service client which will be wrapped by this object

activate_cluster_placement_group_and_wait_for_state(cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls activate_cluster_placement_group() and waits for the ClusterPlacementGroup acted upon to enter the given state(s).

Parameters
  • cluster_placement_group_id (str) – (required) A unique cluster placement group 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 activate_cluster_placement_group()

  • 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

create_cluster_placement_group_and_wait_for_state(create_cluster_placement_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • create_cluster_placement_group_details (oci.cluster_placement_groups.models.CreateClusterPlacementGroupDetails) – (required) The details for creating the new cluster placement group.

  • 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_placement_group()

  • 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

deactivate_cluster_placement_group_and_wait_for_state(cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls deactivate_cluster_placement_group() and waits for the ClusterPlacementGroup acted upon to enter the given state(s).

Parameters
  • cluster_placement_group_id (str) – (required) A unique cluster placement group 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 deactivate_cluster_placement_group()

  • 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_placement_group_and_wait_for_state(cluster_placement_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • cluster_placement_group_id (str) – (required) A unique cluster placement group identifier.

  • 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_placement_group()

  • 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_placement_group_and_wait_for_state(cluster_placement_group_id, update_cluster_placement_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters
  • cluster_placement_group_id (str) – (required) A unique cluster placement group identifier.

  • update_cluster_placement_group_details (oci.cluster_placement_groups.models.UpdateClusterPlacementGroupDetails) – (required) The details of the cluster placement group to update.

  • 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 update_cluster_placement_group()

  • 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