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.

Source code for google.cloud.billing.budgets_v1.types.budget_model

# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto  # type: ignore

from google.protobuf import struct_pb2  # type: ignore
from google.type import date_pb2  # type: ignore
from google.type import money_pb2  # type: ignore


__protobuf__ = proto.module(
    package="google.cloud.billing.budgets.v1",
    manifest={
        "CalendarPeriod",
        "Budget",
        "BudgetAmount",
        "LastPeriodAmount",
        "ThresholdRule",
        "NotificationsRule",
        "Filter",
        "CustomPeriod",
    },
)


[docs]class CalendarPeriod(proto.Enum): r"""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). """ CALENDAR_PERIOD_UNSPECIFIED = 0 MONTH = 1 QUARTER = 2 YEAR = 3
[docs]class Budget(proto.Message): r"""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. Attributes: name (str): 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}``. display_name (str): User data for display name in UI. The name must be less than or equal to 60 characters. budget_filter (google.cloud.billing.budgets_v1.types.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 (google.cloud.billing.budgets_v1.types.BudgetAmount): Required. Budgeted amount. threshold_rules (Sequence[google.cloud.billing.budgets_v1.types.ThresholdRule]): Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. notifications_rule (google.cloud.billing.budgets_v1.types.NotificationsRule): Optional. Rules to apply to notifications sent based on budget spend and thresholds. etag (str): 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. """ name = proto.Field(proto.STRING, number=1,) display_name = proto.Field(proto.STRING, number=2,) budget_filter = proto.Field(proto.MESSAGE, number=3, message="Filter",) amount = proto.Field(proto.MESSAGE, number=4, message="BudgetAmount",) threshold_rules = proto.RepeatedField( proto.MESSAGE, number=5, message="ThresholdRule", ) notifications_rule = proto.Field( proto.MESSAGE, number=6, message="NotificationsRule", ) etag = proto.Field(proto.STRING, number=7,)
[docs]class BudgetAmount(proto.Message): r"""The budgeted amount for each usage period. Attributes: specified_amount (google.type.money_pb2.Money): 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. last_period_amount (google.cloud.billing.budgets_v1.types.LastPeriodAmount): 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]. """ specified_amount = proto.Field( proto.MESSAGE, number=1, oneof="budget_amount", message=money_pb2.Money, ) last_period_amount = proto.Field( proto.MESSAGE, number=2, oneof="budget_amount", message="LastPeriodAmount", )
[docs]class LastPeriodAmount(proto.Message): r"""Describes 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. 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][google.cloud.billing.budgets.v1.Filter.custom_period]. """
[docs]class ThresholdRule(proto.Message): r"""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``. Attributes: threshold_percent (float): Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. spend_basis (google.cloud.billing.budgets_v1.types.ThresholdRule.Basis): Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. """
[docs] class Basis(proto.Enum): r"""The type of basis used to determine if spend has passed the threshold. """ BASIS_UNSPECIFIED = 0 CURRENT_SPEND = 1 FORECASTED_SPEND = 2
threshold_percent = proto.Field(proto.DOUBLE, number=1,) spend_basis = proto.Field(proto.ENUM, number=2, enum=Basis,)
[docs]class NotificationsRule(proto.Message): r"""NotificationsRule defines notifications that are sent based on budget spend and thresholds. Attributes: pubsub_topic (str): 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. schema_version (str): 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. monitoring_notification_channels (Sequence[str]): 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. disable_default_iam_recipients (bool): 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. """ pubsub_topic = proto.Field(proto.STRING, number=1,) schema_version = proto.Field(proto.STRING, number=2,) monitoring_notification_channels = proto.RepeatedField(proto.STRING, number=3,) disable_default_iam_recipients = proto.Field(proto.BOOL, number=4,)
[docs]class Filter(proto.Message): r"""A filter for a budget, limiting the scope of the cost to calculate. Attributes: projects (Sequence[str]): 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. credit_types (Sequence[str]): 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 <https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type>`__. If [Filter.credit_types_treatment][google.cloud.billing.budgets.v1.Filter.credit_types_treatment] is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. credit_types_treatment (google.cloud.billing.budgets_v1.types.Filter.CreditTypesTreatment): Optional. If not set, default behavior is ``INCLUDE_ALL_CREDITS``. services (Sequence[str]): 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. subaccounts (Sequence[str]): 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. labels (Sequence[google.cloud.billing.budgets_v1.types.Filter.LabelsEntry]): 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. calendar_period (google.cloud.billing.budgets_v1.types.CalendarPeriod): Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on. custom_period (google.cloud.billing.budgets_v1.types.CustomPeriod): Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. """
[docs] class CreditTypesTreatment(proto.Enum): r"""Specifies 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 <https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type>`__. """ CREDIT_TYPES_TREATMENT_UNSPECIFIED = 0 INCLUDE_ALL_CREDITS = 1 EXCLUDE_ALL_CREDITS = 2 INCLUDE_SPECIFIED_CREDITS = 3
projects = proto.RepeatedField(proto.STRING, number=1,) credit_types = proto.RepeatedField(proto.STRING, number=7,) credit_types_treatment = proto.Field( proto.ENUM, number=4, enum=CreditTypesTreatment, ) services = proto.RepeatedField(proto.STRING, number=3,) subaccounts = proto.RepeatedField(proto.STRING, number=5,) labels = proto.MapField( proto.STRING, proto.MESSAGE, number=6, message=struct_pb2.ListValue, ) calendar_period = proto.Field( proto.ENUM, number=8, oneof="usage_period", enum="CalendarPeriod", ) custom_period = proto.Field( proto.MESSAGE, number=9, oneof="usage_period", message="CustomPeriod", )
[docs]class CustomPeriod(proto.Message): r"""All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). Attributes: start_date (google.type.date_pb2.Date): Required. The start date must be after January 1, 2017. end_date (google.type.date_pb2.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. """ start_date = proto.Field(proto.MESSAGE, number=1, message=date_pb2.Date,) end_date = proto.Field(proto.MESSAGE, number=2, message=date_pb2.Date,)
__all__ = tuple(sorted(__protobuf__.manifest))