public final class Filter extends GeneratedMessageV3 implements FilterOrBuilder
A filter for a budget, limiting the scope of the cost to calculate.
Protobuf type google.cloud.billing.budgets.v1.Filter
Static Fields
CALENDAR_PERIOD_FIELD_NUMBER
public static final int CALENDAR_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREDIT_TYPES_FIELD_NUMBER
public static final int CREDIT_TYPES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREDIT_TYPES_TREATMENT_FIELD_NUMBER
public static final int CREDIT_TYPES_TREATMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CUSTOM_PERIOD_FIELD_NUMBER
public static final int CUSTOM_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECTS_FIELD_NUMBER
public static final int PROJECTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICES_FIELD_NUMBER
public static final int SERVICES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUBACCOUNTS_FIELD_NUMBER
public static final int SUBACCOUNTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Filter getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Filter.Builder newBuilder()
newBuilder(Filter prototype)
public static Filter.Builder newBuilder(Filter prototype)
| Parameter |
|---|
| Name | Description |
prototype | Filter
|
public static Filter parseDelimitedFrom(InputStream input)
public static Filter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Filter parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Filter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Filter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Filter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Filter parseFrom(CodedInputStream input)
public static Filter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Filter parseFrom(InputStream input)
public static Filter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Filter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Filter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Filter> parser()
Methods
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. Currently,
multiple entries or multiple values per entry are not allowed. If omitted,
the report will include all labeled and unlabeled usage.
map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCalendarPeriod()
public 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.v1.CalendarPeriod calendar_period = 8 [(.google.api.field_behavior) = OPTIONAL];
getCalendarPeriodValue()
public 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.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 | int
The 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 | int
The 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];
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];
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];
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];
getDefaultInstanceForType()
public Filter getDefaultInstanceForType()
getLabels()
public Map<String,ListValue> getLabels()
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. Currently,
multiple entries or multiple values per entry are not allowed. If omitted,
the report will include all labeled and unlabeled usage.
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. Currently,
multiple entries or multiple values per entry are not allowed. If omitted,
the report will include all labeled and unlabeled usage.
map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
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. Currently,
multiple entries or multiple values per entry are not allowed. If omitted,
the report will include all labeled and unlabeled usage.
map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
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. Currently,
multiple entries or multiple values per entry are not allowed. If omitted,
the report will include all labeled and unlabeled usage.
map<string, .google.protobuf.ListValue> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
getParserForType()
public Parser<Filter> getParserForType()
Overrides
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 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 | int
The 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 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 | int
The 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 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 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 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 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 | int
The 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 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 | int
The 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 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 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 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];
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 will be included. If the field is 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 | int
The 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 will be included. If the field is 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 | int
The 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 will be included. If the field is 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 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 will be included. If the field is 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUsagePeriodCase()
public Filter.UsagePeriodCase getUsagePeriodCase()
hasCalendarPeriod()
public 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.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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Filter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Filter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Filter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
