Module types (0.2.0)

API documentation for billing_budgets_v1beta1.types module.

Classes

AllUpdatesRule

AllUpdatesRule defines notifications that are sent on every update to the billing account's spend, regardless of the thresholds defined using threshold rules.

Required. The schema version of the notification. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how- to/budgets#notification_format

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). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).

User data for display name in UI. Validation: <= 60 chars.

Required. Budgeted amount.

Optional. Rules to apply to all updates to the actual spend, regardless of the thresholds set in threshold_rules.

BudgetAmount

The budgeted amount for each usage period.

A specified amount to use as the budget. currency_code is optional. If specified, it must match the currency of the billing account. The currency_code is provided on output.

CreateBudgetRequest

Request for CreateBudget

Required. Budget to create.

DeleteBudgetRequest

Request for DeleteBudget

Empty

API documentation for billing_budgets_v1beta1.types.Empty class.

FieldMask

API documentation for billing_budgets_v1beta1.types.FieldMask class.

Filter

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

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

GetBudgetRequest

Request for GetBudget

LastPeriodAmount

Describes a budget amount targeted to last period's spend. At this time, the amount is automatically 100% of last period's spend; that is, there are no other options yet. Future configuration will be described here (for example, configuring a percentage of last period's spend).

ListBudgetsRequest

Request for ListBudgets

Optional. The maximum number of budgets to return per page. The default and maximum value are 100.

ListBudgetsResponse

Response for ListBudgets

If not empty, indicates that there may be more budgets that match the request; this value should be passed in a new ListBudgetsRequest.

Money

API documentation for billing_budgets_v1beta1.types.Money class.

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.

Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

UpdateBudgetRequest

Request for UpdateBudget

Optional. Indicates which fields in the provided budget to update. Read-only fields (such as name) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol- buffers/docs/proto3#default for more details about default values.