DesktopServiceClientCompositeOperations¶
- class oci.desktops.DesktopServiceClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
DesktopServiceClientand 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, **kwargs)Creates a new DesktopServiceClientCompositeOperations object
Calls
change_desktop_pool_compartment()and waits for theWorkRequestto enter the given state(s).Calls
create_desktop_pool()and waits for theWorkRequestto enter the given state(s).delete_desktop_and_wait_for_state(desktop_id)Calls
delete_desktop()and waits for theWorkRequestto enter the given state(s).Calls
delete_desktop_pool()and waits for theWorkRequestto enter the given state(s).start_desktop_and_wait_for_state(desktop_id)Calls
start_desktop()and waits for theWorkRequestto enter the given state(s).start_desktop_pool_and_wait_for_state(...[, ...])Calls
start_desktop_pool()and waits for theWorkRequestto enter the given state(s).stop_desktop_and_wait_for_state(desktop_id)Calls
stop_desktop()and waits for theWorkRequestto enter the given state(s).stop_desktop_pool_and_wait_for_state(...[, ...])Calls
stop_desktop_pool()and waits for theWorkRequestto enter the given state(s).update_desktop_and_wait_for_state(...[, ...])Calls
update_desktop()and waits for theWorkRequestto enter the given state(s).Calls
update_desktop_pool()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new DesktopServiceClientCompositeOperations object
- Parameters
client (DesktopServiceClient) – The service client which will be wrapped by this object
- change_desktop_pool_compartment_and_wait_for_state(desktop_pool_id, change_desktop_pool_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_desktop_pool_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_pool_id (str) – (required) The OCID of the desktop pool.
change_desktop_pool_compartment_details (oci.desktops.models.ChangeDesktopPoolCompartmentDetails) – (required) The details of the new compartment of the desktop pool.
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
change_desktop_pool_compartment()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_desktop_pool_and_wait_for_state(create_desktop_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_desktop_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
create_desktop_pool_details (oci.desktops.models.CreateDesktopPoolDetails) – (required) The details of the desktop pool to create.
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_desktop_pool()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_desktop_and_wait_for_state(desktop_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_desktop()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_id (str) – (required) The OCID of the desktop.
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_desktop()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_desktop_pool_and_wait_for_state(desktop_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_desktop_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_pool_id (str) – (required) The OCID of the desktop pool.
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_desktop_pool()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
- start_desktop_and_wait_for_state(desktop_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_desktop()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_id (str) – (required) The OCID of the desktop.
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
start_desktop()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
- start_desktop_pool_and_wait_for_state(desktop_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_desktop_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_pool_id (str) – (required) The OCID of the desktop pool.
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
start_desktop_pool()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
- stop_desktop_and_wait_for_state(desktop_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
stop_desktop()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_id (str) – (required) The OCID of the desktop.
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
stop_desktop()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
- stop_desktop_pool_and_wait_for_state(desktop_pool_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
stop_desktop_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_pool_id (str) – (required) The OCID of the desktop pool.
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
stop_desktop_pool()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_desktop_and_wait_for_state(desktop_id, update_desktop_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_desktop()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_id (str) – (required) The OCID of the desktop.
update_desktop_details (oci.desktops.models.UpdateDesktopDetails) – (required) The details of the update.
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
update_desktop()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_desktop_pool_and_wait_for_state(desktop_pool_id, update_desktop_pool_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_desktop_pool()and waits for theWorkRequestto enter the given state(s).- Parameters
desktop_pool_id (str) – (required) The OCID of the desktop pool.
update_desktop_pool_details (oci.desktops.models.UpdateDesktopPoolDetails) – (required) The details of the update.
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
update_desktop_pool()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