Interface QuotaOperationOrBuilder (1.21.0)

Version 1.21.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.1.10

public interface QuotaOperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels describing the operation.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getConsumerId()

public abstract String getConsumerId()

Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.

string consumer_id = 3;

Returns
Type	Description
String	The consumerId.

getConsumerIdBytes()

public abstract ByteString getConsumerIdBytes()

Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.

string consumer_id = 3;

Returns
Type	Description
ByteString	The bytes for consumerId.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels describing the operation.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels describing the operation.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels describing the operation.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels describing the operation.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMethodName()

public abstract String getMethodName()

Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf

string method_name = 2;

Returns
Type	Description
String	The methodName.

getMethodNameBytes()

public abstract ByteString getMethodNameBytes()

Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf

string method_name = 2;

Returns
Type	Description
ByteString	The bytes for methodName.

getOperationId()

public abstract String getOperationId()

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

string operation_id = 1;

Returns
Type	Description
String	The operationId.

getOperationIdBytes()

public abstract ByteString getOperationIdBytes()

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

string operation_id = 1;

Returns
Type	Description
ByteString	The bytes for operationId.

getQuotaMetrics(int index)

public abstract MetricValueSet getQuotaMetrics(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
MetricValueSet

getQuotaMetricsCount()

public abstract int getQuotaMetricsCount()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
Type	Description
int

getQuotaMetricsList()

public abstract List<MetricValueSet> getQuotaMetricsList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
Type	Description
List<MetricValueSet>

getQuotaMetricsOrBuilder(int index)

public abstract MetricValueSetOrBuilder getQuotaMetricsOrBuilder(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
MetricValueSetOrBuilder

getQuotaMetricsOrBuilderList()

public abstract List<? extends MetricValueSetOrBuilder> getQuotaMetricsOrBuilderList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
Type	Description
List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder>

getQuotaMode()

public abstract QuotaOperation.QuotaMode getQuotaMode()

Quota mode for this operation.

.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Returns
Type	Description
QuotaOperation.QuotaMode	The quotaMode.

getQuotaModeValue()

public abstract int getQuotaModeValue()

Quota mode for this operation.

.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Returns
Type	Description
int	The enum numeric value on the wire for quotaMode.