Class DimensionsInfo (0.10.0) 

public final class DimensionsInfo extends GeneratedMessageV3 implements DimensionsInfoOrBuilder

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

Protobuf type google.api.cloudquotas.v1.DimensionsInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DimensionsInfo

Static Fields

APPLICABLE_LOCATIONS_FIELD_NUMBER

public static final int APPLICABLE_LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

DETAILS_FIELD_NUMBER

public static final int DETAILS_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DimensionsInfo getDefaultInstance()
Returns
Type Description
DimensionsInfo

getDescriptor()

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

newBuilder()

public static DimensionsInfo.Builder newBuilder()
Returns
Type Description
DimensionsInfo.Builder

newBuilder(DimensionsInfo prototype)

public static DimensionsInfo.Builder newBuilder(DimensionsInfo prototype)
Parameter
Name Description
prototype DimensionsInfo
Returns
Type Description
DimensionsInfo.Builder

parseDelimitedFrom(InputStream input)

public static DimensionsInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DimensionsInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DimensionsInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DimensionsInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DimensionsInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DimensionsInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DimensionsInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DimensionsInfo> parser()
Returns
Type Description
Parser<DimensionsInfo>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getDetails()

public QuotaDetails getDetails()

Quota details for the specified dimensions.

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

Returns
Type Description
QuotaDetails

The details.

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

getParserForType()

public Parser<DimensionsInfo> getParserForType()
Returns
Type Description
Parser<DimensionsInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DimensionsInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DimensionsInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException