Class QuotaConfig (0.7.0)

public final class QuotaConfig extends GeneratedMessageV3 implements QuotaConfigOrBuilder

The preferred quota configuration.

Protobuf type google.api.cloudquotas.v1.QuotaConfig

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

GRANTED_VALUE_FIELD_NUMBER

public static final int GRANTED_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

PREFERRED_VALUE_FIELD_NUMBER

public static final int PREFERRED_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ORIGIN_FIELD_NUMBER

public static final int REQUEST_ORIGIN_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_DETAIL_FIELD_NUMBER

public static final int STATE_DETAIL_FIELD_NUMBER
Field Value
TypeDescription
int

TRACE_ID_FIELD_NUMBER

public static final int TRACE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuotaConfig getDefaultInstance()
Returns
TypeDescription
QuotaConfig

getDescriptor()

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

newBuilder()

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

newBuilder(QuotaConfig prototype)

public static QuotaConfig.Builder newBuilder(QuotaConfig prototype)
Parameter
NameDescription
prototypeQuotaConfig
Returns
TypeDescription
QuotaConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<QuotaConfig> parser()
Returns
TypeDescription
Parser<QuotaConfig>

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public QuotaConfig getDefaultInstanceForType()
Returns
TypeDescription
QuotaConfig

getGrantedValue()

public Int64Value getGrantedValue()

Output only. Granted quota value.

.google.protobuf.Int64Value granted_value = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Int64Value

The grantedValue.

getGrantedValueOrBuilder()

public Int64ValueOrBuilder getGrantedValueOrBuilder()

Output only. Granted quota value.

.google.protobuf.Int64Value granted_value = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Int64ValueOrBuilder

getParserForType()

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

getPreferredValue()

public long getPreferredValue()

Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".

int64 preferred_value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The preferredValue.

getRequestOrigin()

public QuotaConfig.Origin getRequestOrigin()

Output only. The origin of the quota preference request.

.google.api.cloudquotas.v1.QuotaConfig.Origin request_origin = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
QuotaConfig.Origin

The requestOrigin.

getRequestOriginValue()

public int getRequestOriginValue()

Output only. The origin of the quota preference request.

.google.api.cloudquotas.v1.QuotaConfig.Origin request_origin = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for requestOrigin.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStateDetail()

public String getStateDetail()

Output only. Optional details about the state of this quota preference.

string state_detail = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stateDetail.

getStateDetailBytes()

public ByteString getStateDetailBytes()

Output only. Optional details about the state of this quota preference.

string state_detail = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stateDetail.

getTraceId()

public String getTraceId()

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

string trace_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The traceId.

getTraceIdBytes()

public ByteString getTraceIdBytes()

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

string trace_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for traceId.

hasGrantedValue()

public boolean hasGrantedValue()

Output only. Granted quota value.

.google.protobuf.Int64Value granted_value = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the grantedValue 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 QuotaConfig.Builder newBuilderForType()
Returns
TypeDescription
QuotaConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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