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

Methods:

__init__(client[, work_request_client])

Creates a new ComputeManagementClientCompositeOperations object

attach_instance_pool_instance_and_wait_for_state(...)

Calls attach_instance_pool_instance() and waits for the InstancePoolInstance acted upon to enter the given state(s).

attach_instance_pool_instance_and_wait_for_work_request(...)

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

attach_load_balancer_and_wait_for_state(...)

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

create_cluster_network_and_wait_for_state(...)

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

create_cluster_network_and_wait_for_work_request(...)

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

create_instance_pool_and_wait_for_state(...)

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

detach_instance_pool_instance_and_wait_for_work_request(...)

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

detach_load_balancer_and_wait_for_state(...)

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

launch_instance_configuration_and_wait_for_work_request(...)

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

reset_instance_pool_and_wait_for_state(...)

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

softreset_instance_pool_and_wait_for_state(...)

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

softstop_instance_pool_and_wait_for_state(...)

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

start_instance_pool_and_wait_for_state(...)

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

stop_instance_pool_and_wait_for_state(...[, ...])

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

terminate_cluster_network_and_wait_for_work_request(...)

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

terminate_instance_pool_and_wait_for_state(...)

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

update_cluster_network_and_wait_for_state(...)

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

update_instance_pool_and_wait_for_state(...)

Calls update_instance_pool() and waits for the InstancePool acted upon to enter the given state(s).
__init__(client, work_request_client=None, **kwargs)

Creates a new ComputeManagementClientCompositeOperations object

Parameters
attach_instance_pool_instance_and_wait_for_state(instance_pool_id, attach_instance_pool_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls attach_instance_pool_instance() and waits for the InstancePoolInstance acted upon to enter the given state(s).

Parameters

  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • attach_instance_pool_instance_details (oci.core.models.AttachInstancePoolInstanceDetails) – (required) Attach an instance to a 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 attach_instance_pool_instance()

  • 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

attach_instance_pool_instance_and_wait_for_work_request(instance_pool_id, attach_instance_pool_instance_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • attach_instance_pool_instance_details (oci.core.models.AttachInstancePoolInstanceDetails) – (required) Attach an instance to a pool

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

  • 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

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 (oci.core.models.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 (oci.core.models.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 (oci.core.models.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 (oci.core.models.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_instance_pool_instance_and_wait_for_work_request(instance_pool_id, detach_instance_pool_instance_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

  • instance_pool_id (str) –

    (required) The OCID of the instance pool.

  • detach_instance_pool_instance_details (oci.core.models.DetachInstancePoolInstanceDetails) – (required) Instance being detached

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

  • 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 (oci.core.models.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 (oci.core.models.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

softstop_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls softstop_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 softstop_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_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 (oci.core.models.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 (oci.core.models.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