package google.cloud.billing.budgets.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.

• rpc CreateBudget (CreateBudgetRequest, Budget)

  budget_service.proto:40

  Creates a new budget if none exists. There is a limit of 1,000 budgets per billing account.

  message CreateBudgetRequest

  budget_service.proto:78

  Request for CreateBudget

  • string parent = 1

    Required. the name of the billing account to create the budget in. Values are of the form `billingAccounts/{billingAccountId}`.

  • optional Budget budget = 2

    Required. Budget to create.

• rpc UpdateBudget (UpdateBudgetRequest, Budget)

  budget_service.proto:48

  Updates a budget and returns the updated budget.

  message UpdateBudgetRequest

  budget_service.proto:93

  Request for UpdateBudget

  • optional Budget budget = 1

    Required. The updated budget object. The budget to update is specified by the budget name in the budget.

  • optional protobuf.FieldMask update_mask = 2

    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.

• rpc GetBudget (GetBudgetRequest, Budget)

  budget_service.proto:56

  Returns a budget.

  message GetBudgetRequest

  budget_service.proto:108

  Request for GetBudget

  • string name = 1

    Required. Name of budget to get. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.

• rpc ListBudgets (ListBudgetsRequest, ListBudgetsResponse)

  budget_service.proto:63

  Returns the budgets for a billing account.

  message ListBudgetsRequest

  budget_service.proto:120

  Request for ListBudgets

  • string parent = 1

    Required. Name of billing account to list budgets under. Values are of the form `billingAccounts/{billingAccountId}`.

  • int32 page_size = 2

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

  • string page_token = 3

    Optional. The value returned by the last `ListBudgetsResponse` which indicates that this is a continuation of a prior `ListBudgets` call, and that the system should return the next page of data.

  message ListBudgetsResponse

  budget_service.proto:141

  Response for ListBudgets

  • repeated Budget budgets = 1

    List of the budgets owned by the requested billing account.

  • string next_page_token = 2

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

• rpc DeleteBudget (DeleteBudgetRequest, protobuf.Empty)

  budget_service.proto:70

  Deletes a budget. Returns successfully if already deleted.

  message DeleteBudgetRequest

  budget_service.proto:151

  Request for DeleteBudget

  • string name = 1

    Required. Name of the budget to delete. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.

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

Used in: Budget

• string pubsub_topic = 1

  Required. The name of the Cloud Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent at regular intervals to the topic. When a topic is set for a budget, the `pubsub.topics.publish` IAM permission must be granted on the topic (or the parent project of the topic) to `billing-budget-alert@system.gserviceaccount.com`. If this permission is not present when a topic is provided at the time of budget creation or updating, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/pubsub/docs/access-control for more details on Pub/Sub roles and permissions.

• string schema_version = 2

  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

A budget is a plan that describes what the user expects to spend on Cloud projects, plus rules to execute as spend is tracked against that plan, e.g. alert at 90% of $100 target. Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).

Used as response type in: BudgetService.CreateBudget, BudgetService.GetBudget, BudgetService.UpdateBudget

Used as field type in: CreateBudgetRequest, ListBudgetsResponse, UpdateBudgetRequest

• string name = 1

  Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`.

• string display_name = 2

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

• optional Filter budget_filter = 3

  Optional. Filters that define which resources are used to compute the actual spend against the budget.

• optional BudgetAmount amount = 4

  Required. Budgeted amount.

• repeated ThresholdRule threshold_rules = 5

  Required. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.

• optional AllUpdatesRule all_updates_rule = 6

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

• string etag = 7

  Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

The budgeted amount for each usage period.

Used in: Budget

• oneof budget_amount

  Specification for what amount to use as the budget.

  • type.Money specified_amount = 1

    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.

  • LastPeriodAmount last_period_amount = 2

    Use the last period's actual spend as the budget for the present period.

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

Used in: Budget

• repeated string projects = 1

  Optional. A set of projects of the form `projects/{project_id}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.

• Filter.CreditTypesTreatment credit_types_treatment = 4

  Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.

• repeated string services = 3

  Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

Specifies how credits should be treated when determining spend for threshold calculations.

Used in: Filter

• CREDIT_TYPES_TREATMENT_UNSPECIFIED = 0

• INCLUDE_ALL_CREDITS = 1

  All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.

• EXCLUDE_ALL_CREDITS = 2

  All types of credit are added to the net cost to determine the spend for threshold calculations.

Describes a plan to target last period's spend. There are no options yet. The amount is automatically 100% of last period's spend. Future configuration will go here (e.g. configuring the percentage).

Used in: BudgetAmount

(message has no fields)

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 the billing users who have access to the billing account. The thresholds here have no effect on notifications sent to anything configured under `Budget.all_updates_rule`.

Used in: Budget

• double threshold_percent = 1

  Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

• ThresholdRule.Basis spend_basis = 2

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

The type of basis used to determine if spend has passed the threshold.

Used in: ThresholdRule

• BASIS_UNSPECIFIED = 0

  Unspecified threshold basis.

• CURRENT_SPEND = 1

  Use current spend as the basis for comparison against the threshold.

• FORECASTED_SPEND = 2

  Use forecasted spend for the period as the basis for comparison against the threshold.