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

Interface RateLimitRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimitRequest, RateLimitRequest.Builder
public interface RateLimitRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimitDescriptor
    getDescriptors(int index)
    All rate limit requests must specify at least one RateLimitDescriptor.
    int
    getDescriptorsCount()
    All rate limit requests must specify at least one RateLimitDescriptor.
    List<RateLimitDescriptor>
    getDescriptorsList()
    All rate limit requests must specify at least one RateLimitDescriptor.
    RateLimitDescriptorOrBuilder
    getDescriptorsOrBuilder(int index)
    All rate limit requests must specify at least one RateLimitDescriptor.
    List<? extends RateLimitDescriptorOrBuilder>
    getDescriptorsOrBuilderList()
    All rate limit requests must specify at least one RateLimitDescriptor.
    String
    getDomain()
    All rate limit requests must specify a domain.
    com.google.protobuf.ByteString
    getDomainBytes()
    All rate limit requests must specify a domain.
    int
    getHitsAddend()
    Rate limit requests can optionally specify the number of hits a request adds to the matched limit.

    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

    • getDomain

      String getDomain()
       All rate limit requests must specify a domain. This enables the configuration to be per
 application without fear of overlap. E.g., "envoy".
      string domain = 1;
      Returns:
      The domain.

    • getDomainBytes

      com.google.protobuf.ByteString getDomainBytes()
       All rate limit requests must specify a domain. This enables the configuration to be per
 application without fear of overlap. E.g., "envoy".
      string domain = 1;
      Returns:
      The bytes for domain.

    • getDescriptorsList

      List<RateLimitDescriptor> getDescriptorsList()
       All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 2;

    • getDescriptors

      RateLimitDescriptor getDescriptors(int index)
       All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 2;

    • getDescriptorsCount

      int getDescriptorsCount()
       All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 2;

    • getDescriptorsOrBuilderList

      List<? extends RateLimitDescriptorOrBuilder> getDescriptorsOrBuilderList()
       All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 2;

    • getDescriptorsOrBuilder

      RateLimitDescriptorOrBuilder getDescriptorsOrBuilder(int index)
       All rate limit requests must specify at least one RateLimitDescriptor. Each descriptor is
 processed by the service (see below). If any of the descriptors are over limit, the entire
 request is considered to be over limit.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 2;

    • getHitsAddend

      int getHitsAddend()
       Rate limit requests can optionally specify the number of hits a request adds to the matched
 limit. If the value is not set in the message, a request increases the matched limit by 1.
 This value can be overridden by setting filter state value ``envoy.ratelimit.hits_addend``
 to the desired number. Invalid number (< 0) or number will be ignored.
      uint32 hits_addend = 3;
      Returns:
      The hitsAddend.