Class Filter (1.7.1)

Stay organized with collections Save and categorize content based on your preferences.
Filter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
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 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
credit_types_treatment google.cloud.billing.budgets_v1beta1.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 omitted, the report will include usage from the parent account and all subaccounts, if they exist.
labels Mapping[str, google.protobuf.struct_pb2.ListValue]
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 will include all labeled and unlabeled usage. An object containing a single ``"key": value`` pair. Example: ``{ "name": "wrench" }``. *Currently, multiple entries or multiple values per entry are not allowed.*
calendar_period google.cloud.billing.budgets_v1beta1.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. This field is a member of `oneof`_ ``usage_period``.
custom_period google.cloud.billing.budgets_v1beta1.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. This field is a member of `oneof`_ ``usage_period``.

Inheritance

builtins.object > proto.message.Message > Filter

Classes

CreditTypesTreatment

CreditTypesTreatment(value)

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

LabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.