API documentation for budgets_v1beta1.types package.
Classes
AllUpdatesRule
AllUpdatesRule defines notifications that are sent based on budget spend and thresholds.
Budget
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.
BudgetAmount
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
CalendarPeriod
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).
Values: CALENDAR_PERIOD_UNSPECIFIED (0): Calendar period is unset. This is the default if the budget is for a custom time period (CustomPeriod). MONTH (1): A month. Month starts on the first day of each month, such as January 1, February 1, March 1, and so on. QUARTER (2): A quarter. Quarters start on dates January 1, April 1, July 1, and October 1 of each year. YEAR (3): A year. Year starts on January 1.
CreateBudgetRequest
Request for CreateBudget
CustomPeriod
All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).
DeleteBudgetRequest
Request for DeleteBudget
Filter
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
GetBudgetRequest
Request for GetBudget
LastPeriodAmount
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. Future configuration options will be described here (for example, configuring a percentage of last period's spend). LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.
ListBudgetsRequest
Request for ListBudgets
ListBudgetsResponse
Response for ListBudgets
ThresholdRule
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>__.
UpdateBudgetRequest
Request for UpdateBudget