VbInstanceClientCompositeOperations

class oci.visual_builder.VbInstanceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around VbInstanceClient 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 VbInstanceClientCompositeOperations object
change_vb_instance_compartment_and_wait_for_state(…) Calls change_vb_instance_compartment() and waits for the WorkRequest to enter the given state(s).
create_vb_instance_and_wait_for_state(…[, …]) Calls create_vb_instance() and waits for the WorkRequest to enter the given state(s).
delete_vb_instance_and_wait_for_state(…[, …]) Calls delete_vb_instance() and waits for the WorkRequest to enter the given state(s).
start_vb_instance_and_wait_for_state(…[, …]) Calls start_vb_instance() and waits for the WorkRequest to enter the given state(s).
stop_vb_instance_and_wait_for_state(…[, …]) Calls stop_vb_instance() and waits for the WorkRequest to enter the given state(s).
update_vb_instance_and_wait_for_state(…[, …]) Calls update_vb_instance() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new VbInstanceClientCompositeOperations object

Parameters:client (VbInstanceClient) – The service client which will be wrapped by this object
change_vb_instance_compartment_and_wait_for_state(vb_instance_id, change_vb_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • vb_instance_id (str) – (required) Unique Vb Instance identifier.
  • change_vb_instance_compartment_details (oci.visual_builder.models.ChangeVbInstanceCompartmentDetails) – (required) Details for the update vb 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 change_vb_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_vb_instance_and_wait_for_state(create_vb_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_vb_instance_details (oci.visual_builder.models.CreateVbInstanceDetails) – (required) Details for the new Vb 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_vb_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_vb_instance_and_wait_for_state(vb_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • vb_instance_id (str) – (required) Unique Vb Instance identifier.
  • 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_vb_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_vb_instance_and_wait_for_state(vb_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • vb_instance_id (str) – (required) Unique Vb Instance identifier.
  • 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_vb_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_vb_instance_and_wait_for_state(vb_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • vb_instance_id (str) – (required) Unique Vb Instance identifier.
  • 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_vb_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_vb_instance_and_wait_for_state(vb_instance_id, update_vb_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • vb_instance_id (str) – (required) Unique Vb Instance identifier.
  • update_vb_instance_details (oci.visual_builder.models.UpdateVbInstanceDetails) – (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_vb_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