DashboardClientCompositeOperations¶
- class oci.dashboard_service.DashboardClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
DashboardClientand 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 DashboardClientCompositeOperations object
create_dashboard_and_wait_for_state(...[, ...])Calls
create_dashboard()and waits for theDashboardacted upon to enter the given state(s).delete_dashboard_and_wait_for_state(dashboard_id)Calls
delete_dashboard()and waits for theDashboardacted upon to enter the given state(s).update_dashboard_and_wait_for_state(...[, ...])Calls
update_dashboard()and waits for theDashboardacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new DashboardClientCompositeOperations object
- Parameters
client (DashboardClient) – The service client which will be wrapped by this object
- create_dashboard_and_wait_for_state(create_dashboard_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_dashboard()and waits for theDashboardacted upon to enter the given state(s).- Parameters
create_dashboard_details (oci.dashboard_service.models.CreateDashboardDetails) – (required) Details about the dashboard being created.
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
create_dashboard()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_dashboard_and_wait_for_state(dashboard_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_dashboard()and waits for theDashboardacted upon to enter the given state(s).- Parameters
dashboard_id (str) –
(required) The OCID of the dashboard.
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
delete_dashboard()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_dashboard_and_wait_for_state(dashboard_id, update_dashboard_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_dashboard()and waits for theDashboardacted upon to enter the given state(s).- Parameters
dashboard_id (str) –
(required) The OCID of the dashboard.
update_dashboard_details (oci.dashboard_service.models.UpdateDashboardDetails) – (required) The dashboard details 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_dashboard()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