BudgetClientCompositeOperations¶
-
class
oci.budget.
BudgetClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
BudgetClient
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 functionalityMethods
__init__
(client, **kwargs)Creates a new BudgetClientCompositeOperations object create_alert_rule_and_wait_for_state
(…[, …])Calls create_alert_rule()
and waits for theAlertRule
acted upon to enter the given state(s).create_budget_and_wait_for_state
(…[, …])Calls create_budget()
and waits for theBudget
acted upon to enter the given state(s).delete_budget_and_wait_for_state
(budget_id)Calls delete_budget()
and waits for theBudget
acted upon to enter the given state(s).update_alert_rule_and_wait_for_state
(…[, …])Calls update_alert_rule()
and waits for theAlertRule
acted upon to enter the given state(s).update_budget_and_wait_for_state
(budget_id, …)Calls update_budget()
and waits for theBudget
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new BudgetClientCompositeOperations object
Parameters: client (BudgetClient) – The service client which will be wrapped by this object
-
create_alert_rule_and_wait_for_state
(budget_id, create_alert_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_alert_rule()
and waits for theAlertRule
acted upon to enter the given state(s).Parameters: - budget_id (str) – (required) The unique budget OCID.
- create_alert_rule_details (oci.budget.models.CreateAlertRuleDetails) – (required) Details for the new Alert Rule.
- 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_alert_rule()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_budget_and_wait_for_state
(create_budget_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_budget()
and waits for theBudget
acted upon to enter the given state(s).Parameters: - create_budget_details (oci.budget.models.CreateBudgetDetails) – (required) Details for the new budget.
- 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_budget()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_budget_and_wait_for_state
(budget_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_budget()
and waits for theBudget
acted upon to enter the given state(s).Parameters: - budget_id (str) – (required) The unique budget OCID.
- 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_budget()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_alert_rule_and_wait_for_state
(budget_id, alert_rule_id, update_alert_rule_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_alert_rule()
and waits for theAlertRule
acted upon to enter the given state(s).Parameters: - budget_id (str) – (required) The unique budget OCID.
- alert_rule_id (str) – (required) The unique Alert Rule OCID.
- update_alert_rule_details (oci.budget.models.UpdateAlertRuleDetails) – (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_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_alert_rule()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_budget_and_wait_for_state
(budget_id, update_budget_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_budget()
and waits for theBudget
acted upon to enter the given state(s).Parameters: - budget_id (str) – (required) The unique budget OCID.
- update_budget_details (oci.budget.models.UpdateBudgetDetails) – (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_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_budget()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
-