ComputeManagementClientCompositeOperations

class oci.core.ComputeManagementClientCompositeOperations(client, work_request_client=None, **kwargs)

This class provides a wrapper around ComputeManagementClient 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, work_request_client=None, **kwargs)

Creates a new ComputeManagementClientCompositeOperations object

Parameters:
attach_load_balancer_and_wait_for_state(instance_pool_id, attach_load_balancer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls attach_load_balancer() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • attach_load_balancer_details (AttachLoadBalancerDetails) -- (required) Load balancer being attached
  • 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 attach_load_balancer()
  • 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_network_and_wait_for_state(create_cluster_network_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_cluster_network() and waits for the ClusterNetwork acted upon to enter the given state(s).

Parameters:
  • create_cluster_network_details (CreateClusterNetworkDetails) -- (required) Cluster network creation details
  • 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_cluster_network()
  • 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_network_and_wait_for_work_request(create_cluster_network_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_cluster_network() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

Parameters:
  • create_cluster_network_details (CreateClusterNetworkDetails) -- (required) Cluster network creation details
  • work_request_states (list[str]) -- (optional) An array of work requests states to wait on. These should be valid values for status Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED]
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to create_cluster_network()
  • 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_instance_pool_and_wait_for_state(create_instance_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • create_instance_pool_details (CreateInstancePoolDetails) -- (required) Instance pool creation details
  • 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_instance_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
detach_load_balancer_and_wait_for_state(instance_pool_id, detach_load_balancer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls detach_load_balancer() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • detach_load_balancer_details (DetachLoadBalancerDetails) -- (required) Load balancer being detached
  • 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 detach_load_balancer()
  • 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
launch_instance_configuration_and_wait_for_work_request(instance_configuration_id, instance_configuration, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

Calls launch_instance_configuration() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

Parameters:
  • instance_configuration_id (str) -- (required) The OCID of the instance configuration.
  • instance_configuration (InstanceConfigurationInstanceDetails) -- (required) Instance configuration Instance Details
  • work_request_states (list[str]) -- (optional) An array of work requests states to wait on. These should be valid values for status Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED]
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to launch_instance_configuration()
  • 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
reset_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls reset_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • 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 reset_instance_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
softreset_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls softreset_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • 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 softreset_instance_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
start_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • 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 start_instance_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
stop_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • 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 stop_instance_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
terminate_cluster_network_and_wait_for_state(cluster_network_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • cluster_network_id (str) -- (required) The OCID of the cluster network.
  • 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 terminate_cluster_network()
  • 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
terminate_cluster_network_and_wait_for_work_request(cluster_network_id, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

Calls terminate_cluster_network() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

Parameters:
  • cluster_network_id (str) -- (required) The OCID of the cluster network.
  • work_request_states (list[str]) -- (optional) An array of work requests states to wait on. These should be valid values for status Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED]
  • operation_kwargs (dict) -- A dictionary of keyword arguments to pass to terminate_cluster_network()
  • 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
terminate_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls terminate_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • 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 terminate_instance_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_network_and_wait_for_state(cluster_network_id, update_cluster_network_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_cluster_network() and waits for the ClusterNetwork acted upon to enter the given state(s).

Parameters:
  • cluster_network_id (str) -- (required) The OCID of the cluster network.
  • update_cluster_network_details (UpdateClusterNetworkDetails) -- (required) Update cluster network
  • 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_network()
  • 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_instance_pool_and_wait_for_state(instance_pool_id, update_instance_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).

Parameters:
  • instance_pool_id (str) -- (required) The OCID of the instance pool.
  • update_instance_pool_details (UpdateInstancePoolDetails) -- (required) Update instance pool configuration
  • 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_instance_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