Class DimensionsInfo (0.5.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

Static Fields

APPLICABLE_LOCATIONS_FIELD_NUMBER

public static final int APPLICABLE_LOCATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DETAILS_FIELD_NUMBER

public static final int DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DimensionsInfo getDefaultInstance()
Returns
TypeDescription
DimensionsInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DimensionsInfo.Builder newBuilder()
Returns
TypeDescription
DimensionsInfo.Builder

newBuilder(DimensionsInfo prototype)

public static DimensionsInfo.Builder newBuilder(DimensionsInfo prototype)
Parameter
NameDescription
prototypeDimensionsInfo
Returns
TypeDescription
DimensionsInfo.Builder

parseDelimitedFrom(InputStream input)

public static DimensionsInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DimensionsInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DimensionsInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DimensionsInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DimensionsInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DimensionsInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DimensionsInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DimensionsInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DimensionsInfo> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the applicableLocations.

getDefaultInstanceForType()

public DimensionsInfo getDefaultInstanceForType()
Returns
TypeDescription
DimensionsInfo

getDetails()

public QuotaDetails getDetails()

Quota details for the specified dimensions.

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

Returns
TypeDescription
QuotaDetails

The details.

getDetailsOrBuilder()

public QuotaDetailsOrBuilder getDetailsOrBuilder()

Quota details for the specified dimensions.

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

Returns
TypeDescription
QuotaDetailsOrBuilder

getDimensions() (deprecated)

public Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<DimensionsInfo> getParserForType()
Returns
TypeDescription
Parser<DimensionsInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDetails()

public boolean hasDetails()

Quota details for the specified dimensions.

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

Returns
TypeDescription
boolean

Whether the details field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DimensionsInfo.Builder newBuilderForType()
Returns
TypeDescription
DimensionsInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DimensionsInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DimensionsInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DimensionsInfo.Builder toBuilder()
Returns
TypeDescription
DimensionsInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException