com.google.cloud.billing.budgets.v1beta1

Interface FilterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Filter, Filter.Builder

public interface FilterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
CalendarPeriod	getCalendarPeriod() Optional.
int	getCalendarPeriodValue() Optional.
String	getCreditTypes(int index) Optional.
com.google.protobuf.ByteString	getCreditTypesBytes(int index) Optional.
int	getCreditTypesCount() Optional.
List<String>	getCreditTypesList() Optional.
Filter.CreditTypesTreatment	getCreditTypesTreatment() Optional.
int	getCreditTypesTreatmentValue() Optional.
CustomPeriod	getCustomPeriod() Optional.
CustomPeriodOrBuilder	getCustomPeriodOrBuilder() Optional.
Map<String,com.google.protobuf.ListValue>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,com.google.protobuf.ListValue>	getLabelsMap() Optional.
com.google.protobuf.ListValue	getLabelsOrDefault(String key, com.google.protobuf.ListValue defaultValue) Optional.
com.google.protobuf.ListValue	getLabelsOrThrow(String key) Optional.
String	getProjects(int index) Optional.
com.google.protobuf.ByteString	getProjectsBytes(int index) Optional.
int	getProjectsCount() Optional.
List<String>	getProjectsList() Optional.
String	getResourceAncestors(int index) Optional.
com.google.protobuf.ByteString	getResourceAncestorsBytes(int index) Optional.
int	getResourceAncestorsCount() Optional.
List<String>	getResourceAncestorsList() Optional.
String	getServices(int index) Optional.
com.google.protobuf.ByteString	getServicesBytes(int index) Optional.
int	getServicesCount() Optional.
List<String>	getServicesList() Optional.
String	getSubaccounts(int index) Optional.
com.google.protobuf.ByteString	getSubaccountsBytes(int index) Optional.
int	getSubaccountsCount() Optional.
List<String>	getSubaccountsList() Optional.
Filter.UsagePeriodCase	getUsagePeriodCase()
boolean	hasCalendarPeriod() Optional.
boolean	hasCustomPeriod() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getProjectsList

List<String> getProjectsList()

 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.
 

repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the projects.

getProjectsCount

int getProjectsCount()

 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.
 

repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of projects.

getProjects

String getProjects(int index)

 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.
 

repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The projects at the given index.

getProjectsBytes

com.google.protobuf.ByteString getProjectsBytes(int index)

 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.
 

repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the projects at the given index.

getResourceAncestorsList

List<String> getResourceAncestorsList()

 Optional. A set of folder and organization names of the form
 `folders/{folderId}` or `organizations/{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.
 

repeated string resource_ancestors = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the resourceAncestors.

getResourceAncestorsCount

int getResourceAncestorsCount()

 Optional. A set of folder and organization names of the form
 `folders/{folderId}` or `organizations/{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.
 

repeated string resource_ancestors = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of resourceAncestors.

getResourceAncestors

String getResourceAncestors(int index)

 Optional. A set of folder and organization names of the form
 `folders/{folderId}` or `organizations/{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.
 

repeated string resource_ancestors = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The resourceAncestors at the given index.

getResourceAncestorsBytes

com.google.protobuf.ByteString getResourceAncestorsBytes(int index)

 Optional. A set of folder and organization names of the form
 `folders/{folderId}` or `organizations/{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.
 

repeated string resource_ancestors = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the resourceAncestors at the given index.

getCreditTypesList

List<String> getCreditTypesList()

 Optional. If
 [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.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.v1beta1.Filter.credit_types_treatment]
 is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
 

repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the creditTypes.

getCreditTypesCount

int getCreditTypesCount()

 Optional. If
 [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.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.v1beta1.Filter.credit_types_treatment]
 is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
 

repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of creditTypes.

getCreditTypes

String getCreditTypes(int index)

 Optional. If
 [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.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.v1beta1.Filter.credit_types_treatment]
 is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
 

repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The creditTypes at the given index.

getCreditTypesBytes

com.google.protobuf.ByteString getCreditTypesBytes(int index)

 Optional. If
 [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.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.v1beta1.Filter.credit_types_treatment]
 is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
 

repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the creditTypes at the given index.

getCreditTypesTreatmentValue

int getCreditTypesTreatmentValue()

 Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
 

.google.cloud.billing.budgets.v1beta1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for creditTypesTreatment.

getCreditTypesTreatment

Filter.CreditTypesTreatment getCreditTypesTreatment()

 Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
 

.google.cloud.billing.budgets.v1beta1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The creditTypesTreatment.

getServicesList

List<String> getServicesList()

 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.
 

repeated string services = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the services.

getServicesCount

int getServicesCount()

 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.
 

repeated string services = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of services.

getServices

String getServices(int index)

 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.
 

repeated string services = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The services at the given index.

getServicesBytes

com.google.protobuf.ByteString getServicesBytes(int index)

 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.
 

repeated string services = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the services at the given index.

getSubaccountsList

List<String> getSubaccountsList()

 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.
 

repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the subaccounts.

getSubaccountsCount

int getSubaccountsCount()

 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.
 

repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of subaccounts.

getSubaccounts

String getSubaccounts(int index)

 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.
 

repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The subaccounts at the given index.

getSubaccountsBytes

com.google.protobuf.ByteString getSubaccountsBytes(int index)

 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.
 

repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the subaccounts at the given index.

getLabelsCount

int getLabelsCount()

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

map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

boolean containsLabels(String key)

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

map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,com.google.protobuf.ListValue> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,com.google.protobuf.ListValue> getLabelsMap()

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

map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

com.google.protobuf.ListValue getLabelsOrDefault(String key,
                                                 com.google.protobuf.ListValue defaultValue)

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

map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

com.google.protobuf.ListValue getLabelsOrThrow(String key)

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

map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

hasCalendarPeriod

boolean hasCalendarPeriod()

 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.
 

.google.cloud.billing.budgets.v1beta1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the calendarPeriod field is set.

getCalendarPeriodValue

int getCalendarPeriodValue()

 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.
 

.google.cloud.billing.budgets.v1beta1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for calendarPeriod.

getCalendarPeriod

CalendarPeriod getCalendarPeriod()

 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.
 

.google.cloud.billing.budgets.v1beta1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The calendarPeriod.

hasCustomPeriod

boolean hasCustomPeriod()

 Optional. Specifies to track usage from any start date (required) to any
 end date (optional). This time period is static, it does not recur.
 

.google.cloud.billing.budgets.v1beta1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the customPeriod field is set.

getCustomPeriod

CustomPeriod getCustomPeriod()

 Optional. Specifies to track usage from any start date (required) to any
 end date (optional). This time period is static, it does not recur.
 

.google.cloud.billing.budgets.v1beta1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The customPeriod.

getCustomPeriodOrBuilder

CustomPeriodOrBuilder getCustomPeriodOrBuilder()

 Optional. Specifies to track usage from any start date (required) to any
 end date (optional). This time period is static, it does not recur.
 

.google.cloud.billing.budgets.v1beta1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];

getUsagePeriodCase

Filter.UsagePeriodCase getUsagePeriodCase()