Class DimensionsInfo.Builder (0.19.0)

public static final class DimensionsInfo.Builder extends GeneratedMessageV3.Builder<DimensionsInfo.Builder> implements DimensionsInfoOrBuilder

The detailed quota information such as effective quota value for a combination of dimensions.

Protobuf type google.api.cloudquotas.v1.DimensionsInfo

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllApplicableLocations(Iterable<String> values)

public DimensionsInfo.Builder addAllApplicableLocations(Iterable<String> values)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameter
Name Description
values Iterable<String>

The applicableLocations to add.

Returns
Type Description
DimensionsInfo.Builder

This builder for chaining.

addApplicableLocations(String value)

public DimensionsInfo.Builder addApplicableLocations(String value)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameter
Name Description
value String

The applicableLocations to add.

Returns
Type Description
DimensionsInfo.Builder

This builder for chaining.

addApplicableLocationsBytes(ByteString value)

public DimensionsInfo.Builder addApplicableLocationsBytes(ByteString value)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameter
Name Description
value ByteString

The bytes of the applicableLocations to add.

Returns
Type Description
DimensionsInfo.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DimensionsInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DimensionsInfo.Builder
Overrides

build()

public DimensionsInfo build()
Returns
Type Description
DimensionsInfo

buildPartial()

public DimensionsInfo buildPartial()
Returns
Type Description
DimensionsInfo

clear()

public DimensionsInfo.Builder clear()
Returns
Type Description
DimensionsInfo.Builder
Overrides

clearApplicableLocations()

public DimensionsInfo.Builder clearApplicableLocations()

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Returns
Type Description
DimensionsInfo.Builder

This builder for chaining.

clearDetails()

public DimensionsInfo.Builder clearDetails()

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Returns
Type Description
DimensionsInfo.Builder

clearDimensions()

public DimensionsInfo.Builder clearDimensions()
Returns
Type Description
DimensionsInfo.Builder

clearField(Descriptors.FieldDescriptor field)

public DimensionsInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DimensionsInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DimensionsInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DimensionsInfo.Builder
Overrides

clone()

public DimensionsInfo.Builder clone()
Returns
Type Description
DimensionsInfo.Builder
Overrides

containsDimensions(String key)

public boolean containsDimensions(String key)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameter
Name Description
key String
Returns
Type Description
boolean

getApplicableLocations(int index)

public String getApplicableLocations(int index)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The applicableLocations at the given index.

getApplicableLocationsBytes(int index)

public ByteString getApplicableLocationsBytes(int index)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the applicableLocations at the given index.

getApplicableLocationsCount()

public int getApplicableLocationsCount()

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Returns
Type Description
int

The count of applicableLocations.

getApplicableLocationsList()

public ProtocolStringList getApplicableLocationsList()

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Returns
Type Description
ProtocolStringList

A list containing the applicableLocations.

getDefaultInstanceForType()

public DimensionsInfo getDefaultInstanceForType()
Returns
Type Description
DimensionsInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetails()

public QuotaDetails getDetails()

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Returns
Type Description
QuotaDetails

The details.

getDetailsBuilder()

public QuotaDetails.Builder getDetailsBuilder()

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Returns
Type Description
QuotaDetails.Builder

getDetailsOrBuilder()

public QuotaDetailsOrBuilder getDetailsOrBuilder()

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Returns
Type Description
QuotaDetailsOrBuilder

getDimensions() (deprecated)

public Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
Type Description
Map<String,String>

getDimensionsCount()

public int getDimensionsCount()

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Returns
Type Description
int

getDimensionsMap()

public Map<String,String> getDimensionsMap()

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Returns
Type Description
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

public String getDimensionsOrDefault(String key, String defaultValue)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDimensionsOrThrow(String key)

public String getDimensionsOrThrow(String key)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableDimensions() (deprecated)

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

hasDetails()

public boolean hasDetails()

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Returns
Type Description
boolean

Whether the details field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDetails(QuotaDetails value)

public DimensionsInfo.Builder mergeDetails(QuotaDetails value)

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Parameter
Name Description
value QuotaDetails
Returns
Type Description
DimensionsInfo.Builder

mergeFrom(DimensionsInfo other)

public DimensionsInfo.Builder mergeFrom(DimensionsInfo other)
Parameter
Name Description
other DimensionsInfo
Returns
Type Description
DimensionsInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DimensionsInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DimensionsInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DimensionsInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DimensionsInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DimensionsInfo.Builder
Overrides

putAllDimensions(Map<String,String> values)

public DimensionsInfo.Builder putAllDimensions(Map<String,String> values)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
DimensionsInfo.Builder

putDimensions(String key, String value)

public DimensionsInfo.Builder putDimensions(String key, String value)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameters
Name Description
key String
value String
Returns
Type Description
DimensionsInfo.Builder

removeDimensions(String key)

public DimensionsInfo.Builder removeDimensions(String key)

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

map<string, string> dimensions = 1;

Parameter
Name Description
key String
Returns
Type Description
DimensionsInfo.Builder

setApplicableLocations(int index, String value)

public DimensionsInfo.Builder setApplicableLocations(int index, String value)

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

repeated string applicable_locations = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The applicableLocations to set.

Returns
Type Description
DimensionsInfo.Builder

This builder for chaining.

setDetails(QuotaDetails value)

public DimensionsInfo.Builder setDetails(QuotaDetails value)

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Parameter
Name Description
value QuotaDetails
Returns
Type Description
DimensionsInfo.Builder

setDetails(QuotaDetails.Builder builderForValue)

public DimensionsInfo.Builder setDetails(QuotaDetails.Builder builderForValue)

Quota details for the specified dimensions.

.google.api.cloudquotas.v1.QuotaDetails details = 2;

Parameter
Name Description
builderForValue QuotaDetails.Builder
Returns
Type Description
DimensionsInfo.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DimensionsInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DimensionsInfo.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DimensionsInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DimensionsInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DimensionsInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DimensionsInfo.Builder
Overrides