As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Billing Budgets v1 API

class google.cloud.billing.budgets_v1.types.Budget(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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).

name

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}.

Type

str

display_name

User data for display name in UI. The name must be less than or equal to 60 characters.

Type

str

budget_filter

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

Type

Filter

amount

Required. Budgeted amount.

Type

BudgetAmount

threshold_rules

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

Type

Sequence[ThresholdRule]

notifications_rule

Optional. Rules to apply to notifications sent based on budget spend and thresholds.

Type

NotificationsRule

etag

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.

Type

str

class google.cloud.billing.budgets_v1.types.BudgetAmount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The budgeted amount for each usage period.

specified_amount

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.

Type

Money

last_period_amount

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

Type

LastPeriodAmount

class google.cloud.billing.budgets_v1.types.CreateBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for CreateBudget

parent

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

Type

str

budget

Required. Budget to create.

Type

Budget

class google.cloud.billing.budgets_v1.types.DeleteBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for DeleteBudget

name

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

Type

str

class google.cloud.billing.budgets_v1.types.Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

projects

Optional. A set of projects of the form projects/{project}, 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.

Type

Sequence[str]

credit_types

Optional. If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1.Filter.credit_types_treatment] is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations.

If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1.Filter.credit_types_treatment] is not INCLUDE_SPECIFIED_CREDITS, this field must be empty. See a list of acceptable credit type values.

Type

Sequence[str]

credit_types_treatment

Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

Type

CreditTypesTreatment

services

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.

Type

Sequence[str]

subaccounts

Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If the field is omitted, the report will include usage from the parent account and all subaccounts, if they exist.

Type

Sequence[str]

labels

Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. Currently, multiple entries or multiple values per entry are not allowed. If omitted, the report will include all labeled and unlabeled usage.

Type

Sequence[LabelsEntry]

class CreditTypesTreatment(value)[source]

Bases: proto.enums.Enum

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

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.billing.budgets_v1.types.GetBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for GetBudget

name

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

Type

str

class google.cloud.billing.budgets_v1.types.LastPeriodAmount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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).

class google.cloud.billing.budgets_v1.types.ListBudgetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for ListBudgets

parent

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

Type

str

page_size

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

Type

int

page_token

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.

Type

str

class google.cloud.billing.budgets_v1.types.ListBudgetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for ListBudgets

budgets

List of the budgets owned by the requested billing account.

Type

Sequence[Budget]

next_page_token

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

Type

str

class google.cloud.billing.budgets_v1.types.NotificationsRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

pubsub_topic

Optional. The name of the 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. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it’s set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details on Pub/Sub roles and permissions.

Type

str

schema_version

Optional. The schema version of the notification sent to pubsub_topic. Only “1.0” is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format

Type

str

monitoring_notification_channels

Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

Type

Sequence[str]

disable_default_iam_recipients

Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

Type

bool

class google.cloud.billing.budgets_v1.types.ThresholdRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

threshold_percent

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

Type

float

spend_basis

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

Type

Basis

class Basis(value)[source]

Bases: proto.enums.Enum

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

class google.cloud.billing.budgets_v1.types.UpdateBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for UpdateBudget

budget

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

Type

Budget

update_mask

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.

Type

FieldMask