- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.0
- 2.1.7
public interface FilterOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCalendarPeriod()
public abstract 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 | |
|---|---|
| Type | Description |
CalendarPeriod | The calendarPeriod. |
getCalendarPeriodValue()
public abstract 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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for calendarPeriod. |
getCreditTypes(int index)
public abstract String getCreditTypes(int index)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.
repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The creditTypes at the given index. |
getCreditTypesBytes(int index)
public abstract ByteString getCreditTypesBytes(int index)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.
repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the creditTypes at the given index. |
getCreditTypesCount()
public abstract int getCreditTypesCount()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.
repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The count of creditTypes. |
getCreditTypesList()
public abstract List<String> getCreditTypesList()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.
repeated string credit_types = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the creditTypes. |
getCreditTypesTreatment()
public abstract 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 | |
|---|---|
| Type | Description |
Filter.CreditTypesTreatment | The creditTypesTreatment. |
getCreditTypesTreatmentValue()
public abstract 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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for creditTypesTreatment. |
getCustomPeriod()
public abstract 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 | |
|---|---|
| Type | Description |
CustomPeriod | The customPeriod. |
getCustomPeriodOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CustomPeriodOrBuilder | |
getLabels()
public abstract Map<String,ListValue> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ListValue> | |
getLabelsCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public abstract Map<String,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];
| Returns | |
|---|---|
| Type | Description |
Map<String,ListValue> | |
getLabelsOrDefault(String key, ListValue defaultValue)
public abstract ListValue getLabelsOrDefault(String key, 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];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | ListValue |
| Returns | |
|---|---|
| Type | Description |
ListValue | |
getLabelsOrThrow(String key)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
ListValue | |
getProjects(int index)
public abstract 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.
Only zero or one project can be specified currently.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The projects at the given index. |
getProjectsBytes(int index)
public abstract 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.
Only zero or one project can be specified currently.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the projects at the given index. |
getProjectsCount()
public abstract 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.
Only zero or one project can be specified currently.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The count of projects. |
getProjectsList()
public abstract 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.
Only zero or one project can be specified currently.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the projects. |
getServices(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The services at the given index. |
getServicesBytes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the services at the given index. |
getServicesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int | The count of services. |
getServicesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<String> | A list containing the services. |
getSubaccounts(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The subaccounts at the given index. |
getSubaccountsBytes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the subaccounts at the given index. |
getSubaccountsCount()
public abstract 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 | |
|---|---|
| Type | Description |
int | The count of subaccounts. |
getSubaccountsList()
public abstract 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 | |
|---|---|
| Type | Description |
List<String> | A list containing the subaccounts. |
getUsagePeriodCase()
public abstract Filter.UsagePeriodCase getUsagePeriodCase()| Returns | |
|---|---|
| Type | Description |
Filter.UsagePeriodCase | |
hasCalendarPeriod()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the calendarPeriod field is set. |
hasCustomPeriod()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the customPeriod field is set. |