ByolAllocationClientCompositeOperations

class oci.ocvp.ByolAllocationClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around ByolAllocationClient 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_clients])	Creates a new ByolAllocationClientCompositeOperations object
create_byol_allocation_and_wait_for_state(…)	Calls create_byol_allocation() and waits for the WorkRequest to enter the given state(s).
delete_byol_allocation_and_wait_for_state(…)	Calls delete_byol_allocation() and waits for the WorkRequest to enter the given state(s).
update_byol_allocation_and_wait_for_state(…)	Calls update_byol_allocation() and waits for the WorkRequest to enter the given state(s).

__init__(client, work_request_clients=None, **kwargs)

Creates a new ByolAllocationClientCompositeOperations object

Parameters:

• client (ByolAllocationClient) – The service client which will be wrapped by this object
• work_request_clients (dict) –

  (optional) Service-local clients keyed by generated client class name, for example {'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.

  Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.

  Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.

create_byol_allocation_and_wait_for_state(create_byol_allocation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_byol_allocation_details (oci.ocvp.models.CreateByolAllocationDetails) – (required) Details for the BYOL Allocation.
• 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_allocation()
• 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_allocation_and_wait_for_state(byol_allocation_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• byol_allocation_id (str) –

  (required) The OCID of the BYOL Allocation.

• 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_allocation()
• 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_allocation_and_wait_for_state(byol_allocation_id, update_byol_allocation_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• byol_allocation_id (str) –

  (required) The OCID of the BYOL Allocation.

• update_byol_allocation_details (oci.ocvp.models.UpdateByolAllocationDetails) – (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_allocation()
• 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