Package budgets_v1.types (1.14.5)

A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.

The budgeted amount for each usage period.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A CalendarPeriod represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current CalendarPeriod". All calendar times begin at 12 AM US and Canadian Pacific Time (UTC-8).

Request for CreateBudget

All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).

Request for DeleteBudget

A filter for a budget, limiting the scope of the cost to calculate.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Request for GetBudget

Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.

Request for ListBudgets

Response for ListBudgets

NotificationsRule defines notifications that are sent based on budget spend and thresholds.

ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the NotificationsRule <#notificationsrule>__.

Threshold rules also affect the fields included in the JSON data object <https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format>__ sent to a Pub/Sub topic.

Threshold rules are required if using email notifications.

Threshold rules are optional if only setting a `pubsubTopic NotificationsRule <#NotificationsRule>`__, unless you want your JSON data object to include data about the thresholds you set.

For more information, see set budget threshold rules and actions <https://cloud.google.com/billing/docs/how-to/budgets#budget-actions>__.

Request for UpdateBudget