public static final class QuotaOperation.Builder extends GeneratedMessageV3.Builder<QuotaOperation.Builder> implements QuotaOperationOrBuilderRepresents information regarding a quota operation.
Protobuf type google.api.servicecontrol.v1.QuotaOperation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QuotaOperation.BuilderImplements
QuotaOperationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllQuotaMetrics(Iterable<? extends MetricValueSet> values)
public QuotaOperation.Builder addAllQuotaMetrics(Iterable<? extends MetricValueSet> values)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 |
values | Iterable<? extends com.google.api.servicecontrol.v1.MetricValueSet> |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
addQuotaMetrics(MetricValueSet value)
public QuotaOperation.Builder addQuotaMetrics(MetricValueSet value)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 |
value | MetricValueSet |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
addQuotaMetrics(MetricValueSet.Builder builderForValue)
public QuotaOperation.Builder addQuotaMetrics(MetricValueSet.Builder builderForValue)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 |
builderForValue | MetricValueSet.Builder |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
addQuotaMetrics(int index, MetricValueSet value)
public QuotaOperation.Builder addQuotaMetrics(int index, MetricValueSet value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | MetricValueSet |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
addQuotaMetrics(int index, MetricValueSet.Builder builderForValue)
public QuotaOperation.Builder addQuotaMetrics(int index, MetricValueSet.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | MetricValueSet.Builder |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
addQuotaMetricsBuilder()
public MetricValueSet.Builder addQuotaMetricsBuilder()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 |
MetricValueSet.Builder | |
addQuotaMetricsBuilder(int index)
public MetricValueSet.Builder addQuotaMetricsBuilder(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.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public QuotaOperation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
build()
public QuotaOperation build()| Returns | |
|---|---|
| Type | Description |
QuotaOperation | |
buildPartial()
public QuotaOperation buildPartial()| Returns | |
|---|---|
| Type | Description |
QuotaOperation | |
clear()
public QuotaOperation.Builder clear()| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
clearConsumerId()
public QuotaOperation.Builder clearConsumerId()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 |
QuotaOperation.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public QuotaOperation.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
clearLabels()
public QuotaOperation.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
clearMethodName()
public QuotaOperation.Builder clearMethodName()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 |
QuotaOperation.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public QuotaOperation.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
clearOperationId()
public QuotaOperation.Builder clearOperationId()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 |
QuotaOperation.Builder | This builder for chaining. |
clearQuotaMetrics()
public QuotaOperation.Builder clearQuotaMetrics()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 |
QuotaOperation.Builder | |
clearQuotaMode()
public QuotaOperation.Builder clearQuotaMode()Quota mode for this operation.
.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
clone()
public QuotaOperation.Builder clone()| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
containsLabels(String key)
public boolean containsLabels(String key)Labels describing the operation.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getConsumerId()
public 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 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. |
getDefaultInstanceForType()
public QuotaOperation getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
QuotaOperation | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()Labels describing the operation.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public 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 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 String getLabelsOrThrow(String key)Labels describing the operation.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMethodName()
public 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 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. |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getOperationId()
public 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 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 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 | |
getQuotaMetricsBuilder(int index)
public MetricValueSet.Builder getQuotaMetricsBuilder(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.Builder | |
getQuotaMetricsBuilderList()
public List<MetricValueSet.Builder> getQuotaMetricsBuilderList()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<Builder> | |
getQuotaMetricsCount()
public 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(QuotaOperation other)
public QuotaOperation.Builder mergeFrom(QuotaOperation other)| Parameter | |
|---|---|
| Name | Description |
other | QuotaOperation |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public QuotaOperation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public QuotaOperation.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final QuotaOperation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
putAllLabels(Map<String,String> values)
public QuotaOperation.Builder putAllLabels(Map<String,String> values)Labels describing the operation.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
putLabels(String key, String value)
public QuotaOperation.Builder putLabels(String key, String value)Labels describing the operation.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
removeLabels(String key)
public QuotaOperation.Builder removeLabels(String key)Labels describing the operation.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
removeQuotaMetrics(int index)
public QuotaOperation.Builder removeQuotaMetrics(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 |
QuotaOperation.Builder | |
setConsumerId(String value)
public QuotaOperation.Builder setConsumerId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe consumerId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setConsumerIdBytes(ByteString value)
public QuotaOperation.Builder setConsumerIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for consumerId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public QuotaOperation.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
setMethodName(String value)
public QuotaOperation.Builder setMethodName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe methodName to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setMethodNameBytes(ByteString value)
public QuotaOperation.Builder setMethodNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for methodName to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setOperationId(String value)
public QuotaOperation.Builder setOperationId(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe operationId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setOperationIdBytes(ByteString value)
public QuotaOperation.Builder setOperationIdBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for operationId to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setQuotaMetrics(int index, MetricValueSet value)
public QuotaOperation.Builder setQuotaMetrics(int index, MetricValueSet value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | MetricValueSet |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
setQuotaMetrics(int index, MetricValueSet.Builder builderForValue)
public QuotaOperation.Builder setQuotaMetrics(int index, MetricValueSet.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | MetricValueSet.Builder |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
setQuotaMode(QuotaOperation.QuotaMode value)
public QuotaOperation.Builder setQuotaMode(QuotaOperation.QuotaMode value)Quota mode for this operation.
.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
| Parameter | |
|---|---|
| Name | Description |
value | QuotaOperation.QuotaModeThe quotaMode to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setQuotaModeValue(int value)
public QuotaOperation.Builder setQuotaModeValue(int value)Quota mode for this operation.
.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for quotaMode to set. |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public QuotaOperation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final QuotaOperation.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
QuotaOperation.Builder | |