- 2.53.0 (latest)
- 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 static final class Filter.Builder extends GeneratedMessageV3.Builder<Filter.Builder> implements FilterOrBuilderA filter for a budget, limiting the scope of the cost to calculate.
Protobuf type google.cloud.billing.budgets.v1.Filter
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Filter.BuilderImplements
FilterOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllCreditTypes(Iterable<String> values)
public Filter.Builder addAllCreditTypes(Iterable<String> values)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 |
values |
Iterable<String>The creditTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addAllProjects(Iterable<String> values)
public Filter.Builder addAllProjects(Iterable<String> values) 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The projects to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addAllResourceAncestors(Iterable<String> values)
public Filter.Builder addAllResourceAncestors(Iterable<String> values) 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];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The resourceAncestors to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addAllServices(Iterable<String> values)
public Filter.Builder addAllServices(Iterable<String> values) 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 includes 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 |
values |
Iterable<String>The services to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addAllSubaccounts(Iterable<String> values)
public Filter.Builder addAllSubaccounts(Iterable<String> values) 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The subaccounts to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addCreditTypes(String value)
public Filter.Builder addCreditTypes(String value)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 |
value |
StringThe creditTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addCreditTypesBytes(ByteString value)
public Filter.Builder addCreditTypesBytes(ByteString value)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 |
value |
ByteStringThe bytes of the creditTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addProjects(String value)
public Filter.Builder addProjects(String value) 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe projects to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addProjectsBytes(ByteString value)
public Filter.Builder addProjectsBytes(ByteString value) 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the projects to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Filter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
addResourceAncestors(String value)
public Filter.Builder addResourceAncestors(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe resourceAncestors to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addResourceAncestorsBytes(ByteString value)
public Filter.Builder addResourceAncestorsBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the resourceAncestors to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addServices(String value)
public Filter.Builder addServices(String value) 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 includes 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 |
value |
StringThe services to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addServicesBytes(ByteString value)
public Filter.Builder addServicesBytes(ByteString value) 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 includes 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 |
value |
ByteStringThe bytes of the services to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addSubaccounts(String value)
public Filter.Builder addSubaccounts(String value) 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe subaccounts to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
addSubaccountsBytes(ByteString value)
public Filter.Builder addSubaccountsBytes(ByteString value) 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the subaccounts to add. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
build()
public Filter build()| Returns | |
|---|---|
| Type | Description |
Filter |
|
buildPartial()
public Filter buildPartial()| Returns | |
|---|---|
| Type | Description |
Filter |
|
clear()
public Filter.Builder clear()| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clearCalendarPeriod()
public Filter.Builder clearCalendarPeriod()Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
clearCreditTypes()
public Filter.Builder clearCreditTypes()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 |
Filter.Builder |
This builder for chaining. |
clearCreditTypesTreatment()
public Filter.Builder clearCreditTypesTreatment() Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
.google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
clearCustomPeriod()
public Filter.Builder clearCustomPeriod()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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Filter.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clearLabels()
public Filter.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Filter.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clearProjects()
public Filter.Builder clearProjects() 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
clearResourceAncestors()
public Filter.Builder clearResourceAncestors() 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 | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
clearServices()
public Filter.Builder clearServices() 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 includes 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 |
Filter.Builder |
This builder for chaining. |
clearSubaccounts()
public Filter.Builder clearSubaccounts() 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
clearUsagePeriod()
public Filter.Builder clearUsagePeriod()| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
clone()
public Filter.Builder clone()| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
containsLabels(String key)
public 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 includes 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 CalendarPeriod getCalendarPeriod()Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CalendarPeriod |
The calendarPeriod. |
getCalendarPeriodValue()
public int getCalendarPeriodValue()Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the creditTypes. |
getCreditTypesTreatment()
public Filter.CreditTypesTreatment getCreditTypesTreatment() Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
.google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Filter.CreditTypesTreatment |
The creditTypesTreatment. |
getCreditTypesTreatmentValue()
public int getCreditTypesTreatmentValue() Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
.google.cloud.billing.budgets.v1.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 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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CustomPeriod |
The customPeriod. |
getCustomPeriodBuilder()
public CustomPeriod.Builder getCustomPeriodBuilder()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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CustomPeriod.Builder |
|
getCustomPeriodOrBuilder()
public 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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CustomPeriodOrBuilder |
|
getDefaultInstanceForType()
public Filter getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Filter |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLabels() (deprecated)
public Map<String,ListValue> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ListValue> |
|
getLabelsCount()
public 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 includes 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 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 includes 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 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 includes 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 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 includes 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 |
|
getMutableLabels() (deprecated)
public Map<String,ListValue> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,ListValue> |
|
getProjects(int index)
public 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
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 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
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 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of projects. |
getProjectsList()
public ProtocolStringList 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the projects. |
getResourceAncestors(int index)
public 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The resourceAncestors at the given index. |
getResourceAncestorsBytes(int index)
public 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the resourceAncestors at the given index. |
getResourceAncestorsCount()
public 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 | |
|---|---|
| Type | Description |
int |
The count of resourceAncestors. |
getResourceAncestorsList()
public ProtocolStringList 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 | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the resourceAncestors. |
getServices(int index)
public 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 includes 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 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 includes 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 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 includes 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 ProtocolStringList 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 includes 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 |
ProtocolStringList |
A list containing the services. |
getSubaccounts(int index)
public 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 is included. If the field is omitted,
the report includes 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 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 is included. If the field is omitted,
the report includes 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 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 is included. If the field is omitted,
the report includes 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 ProtocolStringList 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the subaccounts. |
getUsagePeriodCase()
public Filter.UsagePeriodCase getUsagePeriodCase()| Returns | |
|---|---|
| Type | Description |
Filter.UsagePeriodCase |
|
hasCalendarPeriod()
public boolean hasCalendarPeriod()Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the calendarPeriod field is set. |
hasCustomPeriod()
public 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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customPeriod field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCustomPeriod(CustomPeriod value)
public Filter.Builder mergeCustomPeriod(CustomPeriod value)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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CustomPeriod |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
mergeFrom(Filter other)
public Filter.Builder mergeFrom(Filter other)| Parameter | |
|---|---|
| Name | Description |
other |
Filter |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Filter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Filter.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Filter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
putAllLabels(Map<String,ListValue> values)
public Filter.Builder putAllLabels(Map<String,ListValue> values)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 includes 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 |
values |
Map<String,ListValue> |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
putLabels(String key, ListValue value)
public Filter.Builder putLabels(String key, ListValue value)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 includes 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 |
value |
ListValue |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
putLabelsBuilderIfAbsent(String key)
public ListValue.Builder putLabelsBuilderIfAbsent(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 includes 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 |
Builder |
|
removeLabels(String key)
public Filter.Builder removeLabels(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 includes 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 |
Filter.Builder |
|
setCalendarPeriod(CalendarPeriod value)
public Filter.Builder setCalendarPeriod(CalendarPeriod value)Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CalendarPeriodThe calendarPeriod to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setCalendarPeriodValue(int value)
public Filter.Builder setCalendarPeriodValue(int value)Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
.google.cloud.billing.budgets.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for calendarPeriod to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setCreditTypes(int index, String value)
public Filter.Builder setCreditTypes(int index, String value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe creditTypes to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setCreditTypesTreatment(Filter.CreditTypesTreatment value)
public Filter.Builder setCreditTypesTreatment(Filter.CreditTypesTreatment value) Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
.google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Filter.CreditTypesTreatmentThe creditTypesTreatment to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setCreditTypesTreatmentValue(int value)
public Filter.Builder setCreditTypesTreatmentValue(int value) Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.
.google.cloud.billing.budgets.v1.Filter.CreditTypesTreatment credit_types_treatment = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for creditTypesTreatment to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setCustomPeriod(CustomPeriod value)
public Filter.Builder setCustomPeriod(CustomPeriod value)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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CustomPeriod |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
setCustomPeriod(CustomPeriod.Builder builderForValue)
public Filter.Builder setCustomPeriod(CustomPeriod.Builder builderForValue)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.v1.CustomPeriod custom_period = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CustomPeriod.Builder |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Filter.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
setProjects(int index, String value)
public Filter.Builder setProjects(int index, String value) 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 includes all usage for
the billing account, regardless of which project the usage occurred on.
repeated string projects = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe projects to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Filter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|
setResourceAncestors(int index, String value)
public Filter.Builder setResourceAncestors(int index, String value) 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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe resourceAncestors to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setServices(int index, String value)
public Filter.Builder setServices(int index, String value) 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 includes 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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe services to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setSubaccounts(int index, String value)
public Filter.Builder setSubaccounts(int index, String value) 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 is included. If the field is omitted,
the report includes usage from the parent account and all subaccounts,
if they exist.
repeated string subaccounts = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe subaccounts to set. |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Filter.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Filter.Builder |
|