Class Quota.Builder (2.34.0)

public static final class Quota.Builder extends GeneratedMessageV3.Builder<Quota.Builder> implements QuotaOrBuilder

Quota configuration helps to achieve fairness and budgeting in service usage.

The metric based quota configuration works this way:

The service configuration defines a set of metrics.
For API calls, the quota.metric_rules maps methods to metrics with corresponding costs.
The quota.limits defines limits on the metrics, which will be used for quota checks at runtime.

An example quota configuration in yaml format:

quota: limits:
- name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000

  (The metric rules bind all methods to the read_calls metric,
   except for the UpdateBook and DeleteBook methods. These two methods
   are mapped to the write_calls metric, with the UpdateBook method
   consuming at twice rate as the DeleteBook method.)
  metric_rules:
  - selector: "*"
    metric_costs:
      library.googleapis.com/read_calls: 1
  - selector: google.example.library.v1.LibraryService.UpdateBook
    metric_costs:
      library.googleapis.com/write_calls: 2
  - selector: google.example.library.v1.LibraryService.DeleteBook
    metric_costs:
      library.googleapis.com/write_calls: 1

Corresponding Metric definition:

  metrics:
  - name: library.googleapis.com/read_calls
    display_name: Read requests
    metric_kind: DELTA
    value_type: INT64

  - name: library.googleapis.com/write_calls
    display_name: Write requests
    metric_kind: DELTA
    value_type: INT64

Protobuf type google.api.Quota

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Quota.Builder

Implements

QuotaOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllLimits(Iterable<? extends QuotaLimit> values)

public Quota.Builder addAllLimits(Iterable<? extends QuotaLimit> values)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.api.QuotaLimit>`

Returns
Type	Description
`Quota.Builder`

addAllMetricRules(Iterable<? extends MetricRule> values)

public Quota.Builder addAllMetricRules(Iterable<? extends MetricRule> values)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.api.MetricRule>`

Returns
Type	Description
`Quota.Builder`

addLimits(QuotaLimit value)

public Quota.Builder addLimits(QuotaLimit value)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`value`	`QuotaLimit`

Returns
Type	Description
`Quota.Builder`

addLimits(QuotaLimit.Builder builderForValue)

public Quota.Builder addLimits(QuotaLimit.Builder builderForValue)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`builderForValue`	`QuotaLimit.Builder`

Returns
Type	Description
`Quota.Builder`

addLimits(int index, QuotaLimit value)

public Quota.Builder addLimits(int index, QuotaLimit value)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameters
Name	Description
`index`	`int`
`value`	`QuotaLimit`

Returns
Type	Description
`Quota.Builder`

addLimits(int index, QuotaLimit.Builder builderForValue)

public Quota.Builder addLimits(int index, QuotaLimit.Builder builderForValue)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`QuotaLimit.Builder`

Returns
Type	Description
`Quota.Builder`

addLimitsBuilder()

public QuotaLimit.Builder addLimitsBuilder()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`QuotaLimit.Builder`

addLimitsBuilder(int index)

public QuotaLimit.Builder addLimitsBuilder(int index)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`QuotaLimit.Builder`

addMetricRules(MetricRule value)

public Quota.Builder addMetricRules(MetricRule value)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`value`	`MetricRule`

Returns
Type	Description
`Quota.Builder`

addMetricRules(MetricRule.Builder builderForValue)

public Quota.Builder addMetricRules(MetricRule.Builder builderForValue)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`builderForValue`	`MetricRule.Builder`

Returns
Type	Description
`Quota.Builder`

addMetricRules(int index, MetricRule value)

public Quota.Builder addMetricRules(int index, MetricRule value)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameters
Name	Description
`index`	`int`
`value`	`MetricRule`

Returns
Type	Description
`Quota.Builder`

addMetricRules(int index, MetricRule.Builder builderForValue)

public Quota.Builder addMetricRules(int index, MetricRule.Builder builderForValue)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`MetricRule.Builder`

Returns
Type	Description
`Quota.Builder`

addMetricRulesBuilder()

public MetricRule.Builder addMetricRulesBuilder()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`MetricRule.Builder`

addMetricRulesBuilder(int index)

public MetricRule.Builder addMetricRulesBuilder(int index)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetricRule.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Quota.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Quota build()

Returns
Type	Description
`Quota`

buildPartial()

public Quota buildPartial()

Returns
Type	Description
`Quota`

clear()

public Quota.Builder clear()

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Quota.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLimits()

public Quota.Builder clearLimits()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`Quota.Builder`

clearMetricRules()

public Quota.Builder clearMetricRules()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`Quota.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public Quota.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public Quota.Builder clone()

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Quota getDefaultInstanceForType()

Returns
Type	Description
`Quota`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLimits(int index)

public QuotaLimit getLimits(int index)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`QuotaLimit`

getLimitsBuilder(int index)

public QuotaLimit.Builder getLimitsBuilder(int index)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`QuotaLimit.Builder`

getLimitsBuilderList()

public List<QuotaLimit.Builder> getLimitsBuilderList()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`List<Builder>`

getLimitsCount()

public int getLimitsCount()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`int`

getLimitsList()

public List<QuotaLimit> getLimitsList()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`List<QuotaLimit>`

getLimitsOrBuilder(int index)

public QuotaLimitOrBuilder getLimitsOrBuilder(int index)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`QuotaLimitOrBuilder`

getLimitsOrBuilderList()

public List<? extends QuotaLimitOrBuilder> getLimitsOrBuilderList()

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Returns
Type	Description
`List<? extends com.google.api.QuotaLimitOrBuilder>`

getMetricRules(int index)

public MetricRule getMetricRules(int index)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetricRule`

getMetricRulesBuilder(int index)

public MetricRule.Builder getMetricRulesBuilder(int index)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetricRule.Builder`

getMetricRulesBuilderList()

public List<MetricRule.Builder> getMetricRulesBuilderList()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`List<Builder>`

getMetricRulesCount()

public int getMetricRulesCount()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`int`

getMetricRulesList()

public List<MetricRule> getMetricRulesList()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`List<MetricRule>`

getMetricRulesOrBuilder(int index)

public MetricRuleOrBuilder getMetricRulesOrBuilder(int index)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`MetricRuleOrBuilder`

getMetricRulesOrBuilderList()

public List<? extends MetricRuleOrBuilder> getMetricRulesOrBuilderList()

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Returns
Type	Description
`List<? extends com.google.api.MetricRuleOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Quota other)

public Quota.Builder mergeFrom(Quota other)

Parameter
Name	Description
`other`	`Quota`

Returns
Type	Description
`Quota.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Quota.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Quota.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Quota.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Quota.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Quota.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeLimits(int index)

public Quota.Builder removeLimits(int index)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Quota.Builder`

removeMetricRules(int index)

public Quota.Builder removeMetricRules(int index)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Quota.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Quota.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLimits(int index, QuotaLimit value)

public Quota.Builder setLimits(int index, QuotaLimit value)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameters
Name	Description
`index`	`int`
`value`	`QuotaLimit`

Returns
Type	Description
`Quota.Builder`

setLimits(int index, QuotaLimit.Builder builderForValue)

public Quota.Builder setLimits(int index, QuotaLimit.Builder builderForValue)

List of QuotaLimit definitions for the service.

repeated .google.api.QuotaLimit limits = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`QuotaLimit.Builder`

Returns
Type	Description
`Quota.Builder`

setMetricRules(int index, MetricRule value)

public Quota.Builder setMetricRules(int index, MetricRule value)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameters
Name	Description
`index`	`int`
`value`	`MetricRule`

Returns
Type	Description
`Quota.Builder`

setMetricRules(int index, MetricRule.Builder builderForValue)

public Quota.Builder setMetricRules(int index, MetricRule.Builder builderForValue)

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

repeated .google.api.MetricRule metric_rules = 4;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`MetricRule.Builder`

Returns
Type	Description
`Quota.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Quota.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Quota.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Quota.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)