Package com.google.api
Class Quota.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
com.google.api.Quota.Builder
- All Implemented Interfaces:
QuotaOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- Quota
public static final class Quota.Builder
extends com.google.protobuf.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: INT64Protobuf type
google.api.Quota
-
Method Summary
Modifier and TypeMethodDescriptionaddAllLimits
(Iterable<? extends QuotaLimit> values) List of QuotaLimit definitions for the service.addAllMetricRules
(Iterable<? extends MetricRule> values) List of MetricRule definitions, each one mapping a selected method to one or more metrics.addLimits
(int index, QuotaLimit value) List of QuotaLimit definitions for the service.addLimits
(int index, QuotaLimit.Builder builderForValue) List of QuotaLimit definitions for the service.addLimits
(QuotaLimit value) List of QuotaLimit definitions for the service.addLimits
(QuotaLimit.Builder builderForValue) List of QuotaLimit definitions for the service.List of QuotaLimit definitions for the service.addLimitsBuilder
(int index) List of QuotaLimit definitions for the service.addMetricRules
(int index, MetricRule value) List of MetricRule definitions, each one mapping a selected method to one or more metrics.addMetricRules
(int index, MetricRule.Builder builderForValue) List of MetricRule definitions, each one mapping a selected method to one or more metrics.addMetricRules
(MetricRule value) List of MetricRule definitions, each one mapping a selected method to one or more metrics.addMetricRules
(MetricRule.Builder builderForValue) List of MetricRule definitions, each one mapping a selected method to one or more metrics.List of MetricRule definitions, each one mapping a selected method to one or more metrics.addMetricRulesBuilder
(int index) List of MetricRule definitions, each one mapping a selected method to one or more metrics.addRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) List of QuotaLimit definitions for the service.List of MetricRule definitions, each one mapping a selected method to one or more metrics.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) clone()
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getLimits
(int index) List of QuotaLimit definitions for the service.getLimitsBuilder
(int index) List of QuotaLimit definitions for the service.List of QuotaLimit definitions for the service.int
List of QuotaLimit definitions for the service.List of QuotaLimit definitions for the service.getLimitsOrBuilder
(int index) List of QuotaLimit definitions for the service.List<? extends QuotaLimitOrBuilder>
List of QuotaLimit definitions for the service.getMetricRules
(int index) List of MetricRule definitions, each one mapping a selected method to one or more metrics.getMetricRulesBuilder
(int index) List of MetricRule definitions, each one mapping a selected method to one or more metrics.List of MetricRule definitions, each one mapping a selected method to one or more metrics.int
List of MetricRule definitions, each one mapping a selected method to one or more metrics.List of MetricRule definitions, each one mapping a selected method to one or more metrics.getMetricRulesOrBuilder
(int index) List of MetricRule definitions, each one mapping a selected method to one or more metrics.List<? extends MetricRuleOrBuilder>
List of MetricRule definitions, each one mapping a selected method to one or more metrics.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) final Quota.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) removeLimits
(int index) List of QuotaLimit definitions for the service.removeMetricRules
(int index) List of MetricRule definitions, each one mapping a selected method to one or more metrics.setLimits
(int index, QuotaLimit value) List of QuotaLimit definitions for the service.setLimits
(int index, QuotaLimit.Builder builderForValue) List of QuotaLimit definitions for the service.setMetricRules
(int index, MetricRule value) List of MetricRule definitions, each one mapping a selected method to one or more metrics.setMetricRules
(int index, MetricRule.Builder builderForValue) List of MetricRule definitions, each one mapping a selected method to one or more metrics.setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) final Quota.Builder
setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
setField
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
setRepeatedField
public Quota.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
addRepeatedField
public Quota.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Quota.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
mergeFrom
public Quota.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Quota.Builder>
- Throws:
IOException
-
getLimitsList
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
- Specified by:
getLimitsList
in interfaceQuotaOrBuilder
-
getLimitsCount
public int getLimitsCount()List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
- Specified by:
getLimitsCount
in interfaceQuotaOrBuilder
-
getLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
- Specified by:
getLimits
in interfaceQuotaOrBuilder
-
setLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
setLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addAllLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
clearLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
removeLimits
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
getLimitsBuilder
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
getLimitsOrBuilder
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
- Specified by:
getLimitsOrBuilder
in interfaceQuotaOrBuilder
-
getLimitsOrBuilderList
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
- Specified by:
getLimitsOrBuilderList
in interfaceQuotaOrBuilder
-
addLimitsBuilder
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
addLimitsBuilder
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
getLimitsBuilderList
List of QuotaLimit definitions for the service.
repeated .google.api.QuotaLimit limits = 3;
-
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 interfaceQuotaOrBuilder
-
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 interfaceQuotaOrBuilder
-
getMetricRules
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 interfaceQuotaOrBuilder
-
setMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
setMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addAllMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
clearMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
removeMetricRules
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
getMetricRulesBuilder
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
getMetricRulesOrBuilder
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 interfaceQuotaOrBuilder
-
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 interfaceQuotaOrBuilder
-
addMetricRulesBuilder
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
addMetricRulesBuilder
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
getMetricRulesBuilderList
List of MetricRule definitions, each one mapping a selected method to one or more metrics.
repeated .google.api.MetricRule metric_rules = 4;
-
setUnknownFields
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Quota.Builder>
-