Package com.google.api

Class Quota

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.Quota
All Implemented Interfaces:
QuotaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Quota extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Quota.Builder
    Quota configuration helps to achieve fairness and budgeting in service usage.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LIMITS_FIELD_NUMBER
     
    static final int
    METRIC_RULES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Quota
    getDefaultInstance()
     
    Quota
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    QuotaLimit
    getLimits(int index)
    List of QuotaLimit definitions for the service.
    int
    getLimitsCount()
    List of QuotaLimit definitions for the service.
    List<QuotaLimit>
    getLimitsList()
    List of QuotaLimit definitions for the service.
    QuotaLimitOrBuilder
    getLimitsOrBuilder(int index)
    List of QuotaLimit definitions for the service.
    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.
    int
    getMetricRulesCount()
    List of MetricRule definitions, each one mapping a selected method to one or more metrics.
    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.
    List<? extends MetricRuleOrBuilder>
    getMetricRulesOrBuilderList()
    List of MetricRule definitions, each one mapping a selected method to one or more metrics.
    com.google.protobuf.Parser<Quota>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Quota.Builder
    newBuilder()
     
    static Quota.Builder
    newBuilder(Quota prototype)
     
    Quota.Builder
    newBuilderForType()
     
    protected Quota.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Quota
    parseDelimitedFrom(InputStream input)
     
    static Quota
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Quota
    parseFrom(byte[] data)
     
    static Quota
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Quota
    parseFrom(com.google.protobuf.ByteString data)
     
    static Quota
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Quota
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Quota
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Quota
    parseFrom(InputStream input)
     
    static Quota
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Quota
    parseFrom(ByteBuffer data)
     
    static Quota
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Quota>
    parser()
     
    Quota.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getLimitsList

      public List<QuotaLimit> getLimitsList()
       List of QuotaLimit definitions for the service.
      repeated .google.api.QuotaLimit limits = 3;
      Specified by:
      getLimitsList in interface QuotaOrBuilder

    • getLimitsOrBuilderList

      public List<? extends QuotaLimitOrBuilder> getLimitsOrBuilderList()
       List of QuotaLimit definitions for the service.
      repeated .google.api.QuotaLimit limits = 3;
      Specified by:
      getLimitsOrBuilderList 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

    • 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

    • 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;
      Specified by:
      getMetricRulesList in interface QuotaOrBuilder

    • 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;
      Specified by:
      getMetricRulesOrBuilderList 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

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Quota parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Quota parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Quota parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Quota parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Quota parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Quota parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Quota parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Quota.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Quota.Builder newBuilder()

    • newBuilder

      public static Quota.Builder newBuilder(Quota prototype)

    • toBuilder

      public Quota.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Quota.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Quota getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Quota> parser()

    • getParserForType

      public com.google.protobuf.Parser<Quota> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Quota getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder