Class QuotaConfig (0.22.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
Type Description
int

GRANTED_VALUE_FIELD_NUMBER

public static final int GRANTED_VALUE_FIELD_NUMBER
Field Value
Type Description
int

PREFERRED_VALUE_FIELD_NUMBER

public static final int PREFERRED_VALUE_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ORIGIN_FIELD_NUMBER

public static final int REQUEST_ORIGIN_FIELD_NUMBER
Field Value
Type Description
int

STATE_DETAIL_FIELD_NUMBER

public static final int STATE_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

TRACE_ID_FIELD_NUMBER

public static final int TRACE_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QuotaConfig getDefaultInstance()
Returns
Type Description
QuotaConfig

getDescriptor()

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

newBuilder()

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

newBuilder(QuotaConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<QuotaConfig> parser()
Returns
Type Description
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
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

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public QuotaConfig getDefaultInstanceForType()
Returns
Type Description
QuotaConfig

getGrantedValue()

public Int64Value getGrantedValue()

Output only. Granted quota value.

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

Returns
Type Description
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
Type Description
Int64ValueOrBuilder

getParserForType()

public Parser<QuotaConfig> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for requestOrigin.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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