DashxApisClientCompositeOperations

class oci.management_dashboard.DashxApisClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DashxApisClient 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 DashxApisClientCompositeOperations object
change_management_dashboards_compartment_and_wait_for_state(…)	Calls change_management_dashboards_compartment() and waits for the ManagementDashboard acted upon to enter the given state(s).
change_management_saved_searches_compartment_and_wait_for_state(…)	Calls change_management_saved_searches_compartment() and waits for the ManagementSavedSearch acted upon to enter the given state(s).
create_management_dashboard_and_wait_for_state(…)	Calls create_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).
create_management_saved_search_and_wait_for_state(…)	Calls create_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).
delete_management_dashboard_and_wait_for_state(…)	Calls delete_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).
delete_management_saved_search_and_wait_for_state(…)	Calls delete_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).
update_management_dashboard_and_wait_for_state(…)	Calls update_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).
update_management_saved_search_and_wait_for_state(…)	Calls update_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new DashxApisClientCompositeOperations object

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

change_management_dashboards_compartment_and_wait_for_state(management_dashboard_id, change_management_dashboards_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_management_dashboards_compartment() and waits for the ManagementDashboard acted upon to enter the given state(s).

Parameters:

• management_dashboard_id (str) – (required) A unique dashboard identifier.
• change_management_dashboards_compartment_details (oci.management_dashboard.models.ChangeManagementDashboardsCompartmentDetails) – (required) ID of the dashboard that is being moved.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_management_dashboards_compartment()
• 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

change_management_saved_searches_compartment_and_wait_for_state(management_saved_search_id, change_management_saved_searches_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls change_management_saved_searches_compartment() and waits for the ManagementSavedSearch acted upon to enter the given state(s).

Parameters:

• management_saved_search_id (str) – (required) A unique saved search identifier.
• change_management_saved_searches_compartment_details (oci.management_dashboard.models.ChangeManagementSavedSearchesCompartmentDetails) – (required) ID of the saved search that is being moved.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to change_management_saved_searches_compartment()
• 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

create_management_dashboard_and_wait_for_state(create_management_dashboard_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).

Parameters:

• create_management_dashboard_details (oci.management_dashboard.models.CreateManagementDashboardDetails) – (required) JSON metadata for creating a new dashboard.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_management_dashboard()
• 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

create_management_saved_search_and_wait_for_state(create_management_saved_search_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).

Parameters:

• create_management_saved_search_details (oci.management_dashboard.models.CreateManagementSavedSearchDetails) – (required) JSON metadata for the saved search.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_management_saved_search()
• 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_management_dashboard_and_wait_for_state(management_dashboard_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).

Parameters:

• management_dashboard_id (str) – (required) A unique dashboard identifier.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_management_dashboard()
• 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_management_saved_search_and_wait_for_state(management_saved_search_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).

Parameters:

• management_saved_search_id (str) – (required) A unique saved search identifier.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_management_saved_search()
• 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_management_dashboard_and_wait_for_state(management_dashboard_id, update_management_dashboard_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_management_dashboard() and waits for the ManagementDashboard acted upon to enter the given state(s).

Parameters:

• management_dashboard_id (str) – (required) A unique dashboard identifier.
• update_management_dashboard_details (oci.management_dashboard.models.UpdateManagementDashboardDetails) – (required) JSON metadata for changed dashboard properties.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_management_dashboard()
• 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_management_saved_search_and_wait_for_state(management_saved_search_id, update_management_saved_search_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_management_saved_search() and waits for the ManagementSavedSearch acted upon to enter the given state(s).

Parameters:

• management_saved_search_id (str) – (required) A unique saved search identifier.
• update_management_saved_search_details (oci.management_dashboard.models.UpdateManagementSavedSearchDetails) – (required) JSON metadata for changed saved search properties.
• wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
• operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_management_saved_search()
• 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