SddcClientCompositeOperations¶
- class oci.ocvp.SddcClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
SddcClientand 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 functionalityMethods:
__init__(client[, work_request_clients])Creates a new SddcClientCompositeOperations object
Calls
cancel_downgrade_hcx()and waits for theWorkRequestto enter the given state(s).create_sddc_and_wait_for_state(...[, ...])Calls
create_sddc()and waits for theWorkRequestto enter the given state(s).delete_sddc_and_wait_for_state(sddc_id[, ...])Calls
delete_sddc()and waits for theWorkRequestto enter the given state(s).downgrade_hcx_and_wait_for_state(...[, ...])Calls
downgrade_hcx()and waits for theWorkRequestto enter the given state(s).Calls
refresh_hcx_license_status()and waits for theWorkRequestto enter the given state(s).update_sddc_and_wait_for_state(sddc_id, ...)Calls
update_sddc()and waits for theSddcacted upon to enter the given state(s).upgrade_hcx_and_wait_for_state(sddc_id[, ...])Calls
upgrade_hcx()and waits for theWorkRequestto enter the given state(s).- __init__(client, work_request_clients=None, **kwargs)¶
Creates a new SddcClientCompositeOperations object
- Parameters
client (SddcClient) – 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.
- cancel_downgrade_hcx_and_wait_for_state(sddc_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
cancel_downgrade_hcx()and waits for theWorkRequestto enter the given state(s).- Parameters
sddc_id (str) –
(required) The OCID of the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
cancel_downgrade_hcx()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_sddc_and_wait_for_state(create_sddc_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_sddc()and waits for theWorkRequestto enter the given state(s).- Parameters
create_sddc_details (oci.ocvp.models.CreateSddcDetails) – (required) Details for the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_sddc()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_sddc_and_wait_for_state(sddc_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_sddc()and waits for theWorkRequestto enter the given state(s).- Parameters
sddc_id (str) –
(required) The OCID of the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_sddc()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- downgrade_hcx_and_wait_for_state(downgrade_hcx_details, sddc_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
downgrade_hcx()and waits for theWorkRequestto enter the given state(s).- Parameters
downgrade_hcx_details (oci.ocvp.models.DowngradeHcxDetails) – (required) The HCX on-premise license keys to be reserved when downgrading from HCX Enterprise to HCX Advanced.
sddc_id (str) –
(required) The OCID of the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
downgrade_hcx()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- refresh_hcx_license_status_and_wait_for_state(sddc_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
refresh_hcx_license_status()and waits for theWorkRequestto enter the given state(s).- Parameters
sddc_id (str) –
(required) The OCID of the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
refresh_hcx_license_status()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_sddc_and_wait_for_state(sddc_id, update_sddc_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_sddc()and waits for theSddcacted upon to enter the given state(s).- Parameters
sddc_id (str) –
(required) The OCID of the SDDC.
update_sddc_details (oci.ocvp.models.UpdateSddcDetails) – (required) The information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_sddc()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- upgrade_hcx_and_wait_for_state(sddc_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
upgrade_hcx()and waits for theWorkRequestto enter the given state(s).- Parameters
sddc_id (str) –
(required) The OCID of the SDDC.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
upgrade_hcx()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait