Interface QuotaConfigOrBuilder (0.15.0)

public interface QuotaConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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

getAnnotations() (deprecated)

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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

getGrantedValue()

public abstract 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 abstract Int64ValueOrBuilder getGrantedValueOrBuilder()

Output only. Granted quota value.

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

Returns
Type Description
Int64ValueOrBuilder

getPreferredValue()

public abstract 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 abstract 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 abstract 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.

getStateDetail()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.