Quota (common-protos-java 1.14.0 API)

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, java.io.Serializable

public final class Quota
extends com.google.protobuf.GeneratedMessageV3
implements QuotaOrBuilder

 Quota configuration helps to achieve fairness and budgeting in service
 usage.
 The 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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static 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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

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

Field Summary

Fields
Modifier and Type Field and Description

static int LIMITS_FIELD_NUMBER

static 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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static Quota`	`getDefaultInstance()`
`Quota`	`getDefaultInstanceForType()`
`static 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.
`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.
`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.
`com.google.protobuf.Parser<Quota>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`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)`
`static Quota`	`parseDelimitedFrom(java.io.InputStream input)`
`static Quota`	`parseDelimitedFrom(java.io.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(java.nio.ByteBuffer data)`
`static Quota`	`parseFrom(java.nio.ByteBuffer 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(java.io.InputStream input)`
`static Quota`	`parseFrom(java.io.InputStream input, 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, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- LIMITS_FIELD_NUMBER
```
public static final int LIMITS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METRIC_RULES_FIELD_NUMBER
```
public static final int METRIC_RULES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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 java.util.List<QuotaLimit> getLimitsList()
```
```
 List of `QuotaLimit` definitions for the service.
 
```
repeated .google.api.QuotaLimit limits = 3;
Specified by:

getLimitsList 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

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