API documentation for budgets_v1.types package.
Classes
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. .. attribute:: specified_amount
A specified amount to use as the budget. currency_code
is optional. If specified when creating a budget, it must
match the currency of the billing account. If specified when
updating a budget, it must match the currency_code of the
existing budget. The currency_code is provided on
output.
:type: google.type.money_pb2.Money
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).
CreateBudgetRequest
Request for CreateBudget .. attribute:: parent
Required. The name of the billing account to create the
budget in. Values are of the form
billingAccounts/{billingAccountId}.
:type: str
CustomPeriod
All date times begin at 12 AM US and Canadian Pacific Time (UTC-8).
DeleteBudgetRequest
Request for DeleteBudget .. attribute:: name
Required. Name of the budget to delete. Values are of the
form
billingAccounts/{billingAccountId}/budgets/{budgetId}.
:type: str
Filter
A filter for a budget, limiting the scope of the cost to calculate.
GetBudgetRequest
Request for GetBudget .. attribute:: name
Required. Name of budget to get. Values are of the form
billingAccounts/{billingAccountId}/budgets/{budgetId}.
:type: str
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 .. attribute:: parent
Required. Name of billing account to list budgets under.
Values are of the form
billingAccounts/{billingAccountId}.
:type: str
ListBudgetsResponse
Response for ListBudgets .. attribute:: budgets
List of the budgets owned by the requested billing account.
:type: Sequence[google.cloud.billing.budgets_v1.types.Budget]
NotificationsRule
NotificationsRule defines notifications that are sent based on budget spend and thresholds.
ThresholdRule
ThresholdRule contains a definition of a threshold which triggers an
alert (a notification of a threshold being crossed) to be sent when
spend goes above the specified amount. Alerts are automatically
e-mailed to users with the Billing Account Administrator role or the
Billing Account User role. The thresholds here have no effect on
notifications sent to anything configured under
Budget.all_updates_rule.
UpdateBudgetRequest
Request for UpdateBudget .. attribute:: budget
Required. The updated budget object. The budget to update is specified by the budget name in the budget.