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.MessageA 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.
- 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
- display_name¶
User data for display name in UI. The name must be less than or equal to 60 characters.
- Type
- budget_filter¶
Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget’s time period, as well as other filters.
- amount¶
Required. Budgeted amount.
- threshold_rules¶
Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.
Optional for
pubsubTopicnotifications.Required if using email notifications.
- Type
MutableSequence[google.cloud.billing.budgets_v1.types.ThresholdRule]
- notifications_rule¶
Optional. Rules to apply to notifications sent based on budget spend and thresholds.
- class google.cloud.billing.budgets_v1.types.BudgetAmount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe 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.
- specified_amount¶
A specified amount to use as the budget.
currency_codeis 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. Thecurrency_codeis provided on output.This field is a member of oneof
budget_amount.- Type
google.type.money_pb2.Money
- last_period_amount¶
Use the last period’s actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget’s time period is a [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period]. It cannot be set in combination with [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
This field is a member of oneof
budget_amount.
- class google.cloud.billing.budgets_v1.types.CalendarPeriod(value)[source]¶
Bases:
proto.enums.EnumA
CalendarPeriodrepresents the abstract concept of a time period that has a canonical start. Grammatically, “the start of the currentCalendarPeriod”. 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.
- class google.cloud.billing.budgets_v1.types.CreateBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for CreateBudget
- parent¶
Required. The name of the billing account to create the budget in. Values are of the form
billingAccounts/{billingAccountId}.- Type
- budget¶
Required. Budget to create.
- class google.cloud.billing.budgets_v1.types.CustomPeriod(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAll date times begin at 12 AM US and Canadian Pacific Time (UTC-8).
- start_date¶
Required. The start date must be after January 1, 2017.
- Type
google.type.date_pb2.Date
- end_date¶
Optional. The end date of the time period. Budgets with elapsed end date won’t be processed. If unset, specifies to track all usage incurred since the start_date.
- Type
google.type.date_pb2.Date
- class google.cloud.billing.budgets_v1.types.DeleteBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for DeleteBudget
- class google.cloud.billing.budgets_v1.types.Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- 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 includes all usage for the billing account, regardless of which project the usage occurred on.- Type
MutableSequence[str]
- resource_ancestors¶
Optional. A set of folder and organization names of the form
folders/{folderId}ororganizations/{organizationId}, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget doesn’t apply to those projects.- Type
MutableSequence[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. See a list of acceptable credit type values.
If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1.Filter.credit_types_treatment] is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.
- Type
MutableSequence[str]
- credit_types_treatment¶
Optional. If not set, default behavior is
INCLUDE_ALL_CREDITS.
- 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 includes 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
MutableSequence[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 is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.- Type
MutableSequence[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. If omitted, the report includes all labeled and unlabeled usage.
An object containing a single
"key": valuepair. Example:{ "name": "wrench" }.Currently, multiple entries or multiple values per entry are not allowed.
- Type
MutableMapping[str, google.protobuf.struct_pb2.ListValue]
- calendar_period¶
Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
This field is a member of oneof
usage_period.
- custom_period¶
Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.
This field is a member of oneof
usage_period.
- class CreditTypesTreatment(value)[source]¶
Bases:
proto.enums.EnumSpecifies how credits are applied when determining the spend for threshold calculations. Budgets track the total cost minus any applicable selected credits. See the documentation for a list of credit types.
- Values:
- CREDIT_TYPES_TREATMENT_UNSPECIFIED (0):
No description available.
- 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.
- INCLUDE_SPECIFIED_CREDITS (3):
Credit types specified in the credit_types field are subtracted from the gross cost to determine the 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.MessageRequest for GetBudget
- class google.cloud.billing.budgets_v1.types.LastPeriodAmount(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDescribes a budget amount targeted to the last [Filter.calendar_period][google.cloud.billing.budgets.v1.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. LastPeriodAmount cannot be set for a budget configured with a [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
- class google.cloud.billing.budgets_v1.types.ListBudgetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for ListBudgets
- parent¶
Required. Name of billing account to list budgets under. Values are of the form
billingAccounts/{billingAccountId}.- Type
- scope¶
Optional. Set the scope of the budgets to be returned, in the format of the resource name. The scope of a budget is the cost that it tracks, such as costs for a single project, or the costs for all projects in a folder. Only project scope (in the format of “projects/project-id” or “projects/123”) is supported in this field. When this field is set to a project’s resource name, the budgets returned are tracking the costs for that project.
- Type
- page_size¶
Optional. The maximum number of budgets to return per page. The default and maximum value are 100.
- Type
- class google.cloud.billing.budgets_v1.types.ListBudgetsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for ListBudgets
- budgets¶
List of the budgets owned by the requested billing account.
- Type
MutableSequence[google.cloud.billing.budgets_v1.types.Budget]
- class google.cloud.billing.budgets_v1.types.NotificationsRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNotificationsRule 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 are published, in the form
projects/{project_id}/topics/{topic_id}. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the threshold rules you’ve set.Note that if you want your Pub/Sub JSON object to contain data for
alertThresholdExceeded, you need at least one alert threshold rule. When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels.To use Pub/Sub topics with budgets, you must do the following:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
Grant the API caller the
pubsub.topics.setIamPolicypermission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see Permissions required for this task.
- Type
- schema_version¶
Optional. Required when [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic] is set. The schema version of the notification sent to [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.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
- monitoring_notification_channels¶
Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the
DefaultIamRecipientswho receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the formprojects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 email notifications are allowed.To customize budget alert email recipients with monitoring notification channels, you must create the monitoring notification channels before you link them to a budget. For guidance on setting up notification channels to use with budgets, see Customize budget alert email recipients.
For Cloud Billing budget alerts, you must use email notification channels. The other types of notification channels are not supported, such as Slack, SMS, or PagerDuty. If you want to send budget notifications to Slack, use a pubsubTopic and configure programmatic notifications.
- Type
MutableSequence[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
- enable_project_level_recipients¶
Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured.
Currently, project level recipients are the users with
Ownerrole on a cloud project.- Type
- class google.cloud.billing.budgets_v1.types.ThresholdRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThresholdRule 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.
Threshold rules also affect the fields included in the JSON data object sent to a Pub/Sub topic.
Threshold rules are required if using email notifications.
Threshold rules are optional if only setting a
`pubsubTopicNotificationsRule <#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.
- 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
- spend_basis¶
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
- class Basis(value)[source]¶
Bases:
proto.enums.EnumThe type of basis used to determine if spend has passed the threshold.
- Values:
- 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. FORECASTED_SPEND can only be set when the budget’s time period is a [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period]. It cannot be set in combination with [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
- class google.cloud.billing.budgets_v1.types.UpdateBudgetRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for UpdateBudget
- budget¶
Required. The updated budget object. The budget to update is specified by the budget name in the 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.
