Package io.envoyproxy.envoy.service.ratelimit.v3

Interface RateLimitResponse.QuotaOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimitResponse.Quota, RateLimitResponse.Quota.Builder
Enclosing class:
RateLimitResponse
public static interface RateLimitResponse.QuotaOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimitResponse.Quota.ExpirationSpecifierCase
    getExpirationSpecifierCase()
     
    String
    getId()
    The unique id that is associated with each Quota either at individual descriptor level or whole descriptor set level.
    com.google.protobuf.ByteString
    getIdBytes()
    The unique id that is associated with each Quota either at individual descriptor level or whole descriptor set level.
    int
    getRequests()
    Number of matching requests granted in quota.
    com.google.protobuf.Timestamp
    getValidUntil()
    Point in time at which the quota expires.
    com.google.protobuf.TimestampOrBuilder
    getValidUntilOrBuilder()
    Point in time at which the quota expires.
    boolean
    hasValidUntil()
    Point in time at which the quota expires.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getRequests

      int getRequests()
       Number of matching requests granted in quota. Must be 1 or more.
      uint32 requests = 1 [(.validate.rules) = { ... }
      Returns:
      The requests.

    • hasValidUntil

      boolean hasValidUntil()
       Point in time at which the quota expires.
      .google.protobuf.Timestamp valid_until = 2;
      Returns:
      Whether the validUntil field is set.

    • getValidUntil

      com.google.protobuf.Timestamp getValidUntil()
       Point in time at which the quota expires.
      .google.protobuf.Timestamp valid_until = 2;
      Returns:
      The validUntil.

    • getValidUntilOrBuilder

      com.google.protobuf.TimestampOrBuilder getValidUntilOrBuilder()
       Point in time at which the quota expires.
      .google.protobuf.Timestamp valid_until = 2;

    • getId

      String getId()
       The unique id that is associated with each Quota either at individual descriptor level or whole descriptor set level.

 For a matching policy with boolean logic, for example, match: "request.headers['environment'] == 'staging' || request.headers['environment'] == 'dev'"),
 the request_headers action produces a distinct list of descriptors for each possible value of the ‘environment’ header even though the granted quota is same.
 Thus, the client will use this id information (returned from RLS server) to correctly correlate the multiple descriptors/descriptor sets that have been granted with same quota (i.e., share the same quota among multiple descriptors or descriptor sets.)

 If id is empty, this id field will be ignored. If quota for the same id changes (e.g. due to configuration update), the old quota will be overridden by the new one. Shared quotas referenced by ID will still adhere to expiration after `valid_until`.
      string id = 3;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The unique id that is associated with each Quota either at individual descriptor level or whole descriptor set level.

 For a matching policy with boolean logic, for example, match: "request.headers['environment'] == 'staging' || request.headers['environment'] == 'dev'"),
 the request_headers action produces a distinct list of descriptors for each possible value of the ‘environment’ header even though the granted quota is same.
 Thus, the client will use this id information (returned from RLS server) to correctly correlate the multiple descriptors/descriptor sets that have been granted with same quota (i.e., share the same quota among multiple descriptors or descriptor sets.)

 If id is empty, this id field will be ignored. If quota for the same id changes (e.g. due to configuration update), the old quota will be overridden by the new one. Shared quotas referenced by ID will still adhere to expiration after `valid_until`.
      string id = 3;
      Returns:
      The bytes for id.

    • getExpirationSpecifierCase

      RateLimitResponse.Quota.ExpirationSpecifierCase getExpirationSpecifierCase()