ContainerEngineClientCompositeOperations

class oci.container_engine.ContainerEngineClientCompositeOperations(client, **kwargs)

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

__init__(client, **kwargs)

Creates a new ContainerEngineClientCompositeOperations object

Parameters:client (ContainerEngineClient) -- 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 (CreateClusterDetails) -- (required) The details of the cluster to create.
  • 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
create_node_pool_and_wait_for_state(create_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_node_pool_details (CreateNodePoolDetails) -- (required) The details of the node pool to create.
  • 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_node_pool()
  • 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
delete_node_pool_and_wait_for_state(node_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • node_pool_id (str) -- (required) The OCID of the node pool.
  • 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_node_pool()
  • 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 WorkRequest to enter the given state(s).

Parameters:
  • cluster_id (str) -- (required) The OCID of the cluster.
  • update_cluster_details (UpdateClusterDetails) -- (required) The details of the cluster 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()
  • 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_node_pool_and_wait_for_state(node_pool_id, update_node_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • node_pool_id (str) -- (required) The OCID of the node pool.
  • update_node_pool_details (UpdateNodePoolDetails) -- (required) The fields to update in a node pool.
  • 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_node_pool()
  • 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