Reference documentation and code samples for the Billing Budgets V1 API class Google::Cloud::Billing::Budgets::V1::Filter.
A filter for a budget, limiting the scope of the cost to calculate.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#calendar_period
def calendar_period() -> ::Google::Cloud::Billing::Budgets::V1::CalendarPeriod
Returns
- (::Google::Cloud::Billing::Budgets::V1::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.
#calendar_period=
def calendar_period=(value) -> ::Google::Cloud::Billing::Budgets::V1::CalendarPeriod
Parameter
- value (::Google::Cloud::Billing::Budgets::V1::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.
Returns
- (::Google::Cloud::Billing::Budgets::V1::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.
#credit_types
def credit_types() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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.
If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.
#credit_types=
def credit_types=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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.
If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.
Returns
-
(::Array<::String>) — 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.
If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.
#credit_types_treatment
def credit_types_treatment() -> ::Google::Cloud::Billing::Budgets::V1::Filter::CreditTypesTreatment
Returns
-
(::Google::Cloud::Billing::Budgets::V1::Filter::CreditTypesTreatment) — Optional. If not set, default behavior is
INCLUDE_ALL_CREDITS.
#credit_types_treatment=
def credit_types_treatment=(value) -> ::Google::Cloud::Billing::Budgets::V1::Filter::CreditTypesTreatment
Parameter
-
value (::Google::Cloud::Billing::Budgets::V1::Filter::CreditTypesTreatment) — Optional. If not set, default behavior is
INCLUDE_ALL_CREDITS.
Returns
-
(::Google::Cloud::Billing::Budgets::V1::Filter::CreditTypesTreatment) — Optional. If not set, default behavior is
INCLUDE_ALL_CREDITS.
#custom_period
def custom_period() -> ::Google::Cloud::Billing::Budgets::V1::CustomPeriod
Returns
- (::Google::Cloud::Billing::Budgets::V1::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.
#custom_period=
def custom_period=(value) -> ::Google::Cloud::Billing::Budgets::V1::CustomPeriod
Parameter
- value (::Google::Cloud::Billing::Budgets::V1::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.
Returns
- (::Google::Cloud::Billing::Budgets::V1::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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}
Returns
- (::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}) — 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}
Parameter
- value (::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}) — 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.
Returns
- (::Google::Protobuf::Map{::String => ::Google::Protobuf::ListValue}) — 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.
#projects
def projects() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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.
#projects=
def projects=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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.
Returns
-
(::Array<::String>) — 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.
#services
def services() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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.
#services=
def services=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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.
Returns
-
(::Array<::String>) — 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
def subaccounts() -> ::Array<::String>
Returns
-
(::Array<::String>) — 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.
#subaccounts=
def subaccounts=(value) -> ::Array<::String>
Parameter
-
value (::Array<::String>) — 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.
Returns
-
(::Array<::String>) — 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.