ByolClientCompositeOperations

class oci.ocvp.ByolClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ByolClient 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 ByolClientCompositeOperations object
create_byol_and_wait_for_state(…[, …])	Calls create_byol() and waits for the WorkRequest to enter the given state(s).
delete_byol_and_wait_for_state(byol_id[, …])	Calls delete_byol() and waits for the WorkRequest to enter the given state(s).
update_byol_and_wait_for_state(byol_id, …)	Calls update_byol() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new ByolClientCompositeOperations object

Parameters:client (ByolClient) – The service client which will be wrapped by this object

create_byol_and_wait_for_state(create_byol_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_byol_details (oci.ocvp.models.CreateByolDetails) – (required) Details for the BYOL.
• 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_byol()
• 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_byol_and_wait_for_state(byol_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• byol_id (str) –

  (required) The OCID of the BYOL.

• 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_byol()
• 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_byol_and_wait_for_state(byol_id, update_byol_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• byol_id (str) –

  (required) The OCID of the BYOL.

• update_byol_details (oci.ocvp.models.UpdateByolDetails) – (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_byol()
• 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