com.google.api

Class Quota.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>

com.google.api.Quota.Builder

All Implemented Interfaces:

QuotaOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

Quota

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

Method Summary

Modifier and Type	Method and Description
Quota.Builder	addAllLimits(java.lang.Iterable<? extends QuotaLimit> values) List of `QuotaLimit` definitions for the service.
Quota.Builder	addAllMetricRules(java.lang.Iterable<? extends MetricRule> values) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	addLimits(int index, QuotaLimit.Builder builderForValue) List of `QuotaLimit` definitions for the service.
Quota.Builder	addLimits(int index, QuotaLimit value) List of `QuotaLimit` definitions for the service.
Quota.Builder	addLimits(QuotaLimit.Builder builderForValue) List of `QuotaLimit` definitions for the service.
Quota.Builder	addLimits(QuotaLimit value) List of `QuotaLimit` definitions for the service.
QuotaLimit.Builder	addLimitsBuilder() List of `QuotaLimit` definitions for the service.
QuotaLimit.Builder	addLimitsBuilder(int index) List of `QuotaLimit` definitions for the service.
Quota.Builder	addMetricRules(int index, MetricRule.Builder builderForValue) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	addMetricRules(int index, MetricRule value) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	addMetricRules(MetricRule.Builder builderForValue) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	addMetricRules(MetricRule value) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
MetricRule.Builder	addMetricRulesBuilder() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
MetricRule.Builder	addMetricRulesBuilder(int index) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
Quota	build()
Quota	buildPartial()
Quota.Builder	clear()
Quota.Builder	clearField(Descriptors.FieldDescriptor field)
Quota.Builder	clearLimits() List of `QuotaLimit` definitions for the service.
Quota.Builder	clearMetricRules() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
Quota.Builder	clone()
Quota	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
QuotaLimit	getLimits(int index) List of `QuotaLimit` definitions for the service.
QuotaLimit.Builder	getLimitsBuilder(int index) List of `QuotaLimit` definitions for the service.
java.util.List<QuotaLimit.Builder>	getLimitsBuilderList() List of `QuotaLimit` definitions for the service.
int	getLimitsCount() List of `QuotaLimit` definitions for the service.
java.util.List<QuotaLimit>	getLimitsList() List of `QuotaLimit` definitions for the service.
QuotaLimitOrBuilder	getLimitsOrBuilder(int index) List of `QuotaLimit` definitions for the service.
java.util.List<? extends QuotaLimitOrBuilder>	getLimitsOrBuilderList() List of `QuotaLimit` definitions for the service.
MetricRule	getMetricRules(int index) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
MetricRule.Builder	getMetricRulesBuilder(int index) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
java.util.List<MetricRule.Builder>	getMetricRulesBuilderList() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
int	getMetricRulesCount() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
java.util.List<MetricRule>	getMetricRulesList() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
MetricRuleOrBuilder	getMetricRulesOrBuilder(int index) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
java.util.List<? extends MetricRuleOrBuilder>	getMetricRulesOrBuilderList() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Quota.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Quota.Builder	mergeFrom(Message other)
Quota.Builder	mergeFrom(Quota other)
Quota.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
Quota.Builder	removeLimits(int index) List of `QuotaLimit` definitions for the service.
Quota.Builder	removeMetricRules(int index) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Quota.Builder	setLimits(int index, QuotaLimit.Builder builderForValue) List of `QuotaLimit` definitions for the service.
Quota.Builder	setLimits(int index, QuotaLimit value) List of `QuotaLimit` definitions for the service.
Quota.Builder	setMetricRules(int index, MetricRule.Builder builderForValue) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	setMetricRules(int index, MetricRule value) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Quota.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Quota.Builder>

clear

public Quota.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Quota.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Quota.Builder>

getDefaultInstanceForType

public Quota getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public Quota build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Quota buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public Quota.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Quota.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<Quota.Builder>

clearField

public Quota.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Quota.Builder>

clearOneof

public Quota.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Quota.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<Quota.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Quota.Builder>

mergeFrom

public Quota.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Quota.Builder>

mergeFrom

public Quota.Builder mergeFrom(Quota other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Quota.Builder>

mergeFrom

public Quota.Builder mergeFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Quota.Builder>

Throws:

java.io.IOException

getLimitsList

public java.util.List<QuotaLimit> getLimitsList()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

Specified by:

getLimitsList in interface QuotaOrBuilder

getLimitsCount

public int getLimitsCount()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

Specified by:

getLimitsCount in interface QuotaOrBuilder

getLimits

public QuotaLimit getLimits(int index)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

Specified by:

getLimits in interface QuotaOrBuilder

setLimits

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

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

setLimits

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

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addLimits

public Quota.Builder addLimits(QuotaLimit value)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addLimits

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

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addLimits

public Quota.Builder addLimits(QuotaLimit.Builder builderForValue)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addLimits

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

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addAllLimits

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

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

clearLimits

public Quota.Builder clearLimits()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

removeLimits

public Quota.Builder removeLimits(int index)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

getLimitsBuilder

public QuotaLimit.Builder getLimitsBuilder(int index)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

getLimitsOrBuilder

public QuotaLimitOrBuilder getLimitsOrBuilder(int index)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

Specified by:

getLimitsOrBuilder in interface QuotaOrBuilder

getLimitsOrBuilderList

public java.util.List<? extends QuotaLimitOrBuilder> getLimitsOrBuilderList()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

Specified by:

getLimitsOrBuilderList in interface QuotaOrBuilder

addLimitsBuilder

public QuotaLimit.Builder addLimitsBuilder()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

addLimitsBuilder

public QuotaLimit.Builder addLimitsBuilder(int index)

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

getLimitsBuilderList

public java.util.List<QuotaLimit.Builder> getLimitsBuilderList()

 List of `QuotaLimit` definitions for the service.
 

repeated .google.api.QuotaLimit limits = 3;

getMetricRulesList

public java.util.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;

Specified by:

getMetricRulesList in interface QuotaOrBuilder

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;

Specified by:

getMetricRulesCount in interface QuotaOrBuilder

getMetricRules

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;

Specified by:

getMetricRules in interface QuotaOrBuilder

setMetricRules

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;

setMetricRules

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;

addMetricRules

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;

addMetricRules

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;

addMetricRules

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;

addMetricRules

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;

addAllMetricRules

public Quota.Builder addAllMetricRules(java.lang.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;

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;

removeMetricRules

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;

getMetricRulesBuilder

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;

getMetricRulesOrBuilder

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;

Specified by:

getMetricRulesOrBuilder in interface QuotaOrBuilder

getMetricRulesOrBuilderList

public java.util.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;

Specified by:

getMetricRulesOrBuilderList in interface QuotaOrBuilder

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;

addMetricRulesBuilder

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;

getMetricRulesBuilderList

public java.util.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;

setUnknownFields

public final Quota.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<Quota.Builder>

mergeUnknownFields

public final Quota.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<Quota.Builder>