ContainerInstanceClientCompositeOperations

class oci.container_instances.ContainerInstanceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ContainerInstanceClient 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 ContainerInstanceClientCompositeOperations object
change_container_instance_compartment_and_wait_for_state(...)	Calls change_container_instance_compartment() and waits for the WorkRequest to enter the given state(s).
create_container_instance_and_wait_for_state(...)	Calls create_container_instance() and waits for the WorkRequest to enter the given state(s).
delete_container_instance_and_wait_for_state(...)	Calls delete_container_instance() and waits for the WorkRequest to enter the given state(s).
restart_container_instance_and_wait_for_state(...)	Calls restart_container_instance() and waits for the WorkRequest to enter the given state(s).
start_container_instance_and_wait_for_state(...)	Calls start_container_instance() and waits for the WorkRequest to enter the given state(s).
stop_container_instance_and_wait_for_state(...)	Calls stop_container_instance() and waits for the WorkRequest to enter the given state(s).
update_container_and_wait_for_state(...[, ...])	Calls update_container() and waits for the WorkRequest to enter the given state(s).
update_container_instance_and_wait_for_state(...)	Calls update_container_instance() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new ContainerInstanceClientCompositeOperations object

Parameters

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

change_container_instance_compartment_and_wait_for_state(container_instance_id, change_container_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container instance.

• change_container_instance_compartment_details (oci.container_instances.models.ChangeContainerInstanceCompartmentDetails) – (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 change_container_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_container_instance_and_wait_for_state(create_container_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• create_container_instance_details (oci.container_instances.models.CreateContainerInstanceDetails) – (required) Details for the new container 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_container_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_container_instance_and_wait_for_state(container_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container 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_container_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

restart_container_instance_and_wait_for_state(container_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container 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 restart_container_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

start_container_instance_and_wait_for_state(container_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container 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 start_container_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

stop_container_instance_and_wait_for_state(container_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container 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 stop_container_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_container_and_wait_for_state(container_id, update_container_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• container_id (str) –

  (required) The OCID of the container.

• update_container_details (oci.container_instances.models.UpdateContainerDetails) – (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_container()

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

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

Parameters

• container_instance_id (str) –

  (required) The OCID of the container instance.

• update_container_instance_details (oci.container_instances.models.UpdateContainerInstanceDetails) – (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_container_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