InstanceClientCompositeOperations

class oci.pss.InstanceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around InstanceClient 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 InstanceClientCompositeOperations object
change_instance_compartment_and_wait_for_state(...)	Calls change_instance_compartment() and waits for the WorkRequest to enter the given state(s).
create_instance_and_wait_for_state(...[, ...])	Calls create_instance() and waits for the WorkRequest to enter the given state(s).
delete_instance_and_wait_for_state(instance_id)	Calls delete_instance() and waits for the WorkRequest to enter the given state(s).
update_instance_and_wait_for_state(...[, ...])	Calls update_instance() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new InstanceClientCompositeOperations object

Parameters

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

change_instance_compartment_and_wait_for_state(instance_id, change_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• instance_id (str) –

  (required) The OCID of the Instance.

• change_instance_compartment_details (oci.pss.models.ChangeInstanceCompartmentDetails) – (required) The compartment move details.

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

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

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

Parameters

• create_instance_details (oci.pss.models.CreateInstanceDetails) – (required) Details for the new Instance.

• 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_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

delete_instance_and_wait_for_state(instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• instance_id (str) –

  (required) The OCID of the Instance.

• 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_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

update_instance_and_wait_for_state(instance_id, update_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• instance_id (str) –

  (required) The OCID of the Instance.

• update_instance_details (oci.pss.models.UpdateInstanceDetails) – (required) The information to be updated.

• 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_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