Package io.envoyproxy.envoy.extensions.filters.network.ratelimit.v3

Interface RateLimitOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimitDescriptor
    getDescriptors(int index)
    The rate limit descriptor list to use in the rate limit service request.
    int
    getDescriptorsCount()
    The rate limit descriptor list to use in the rate limit service request.
    List<RateLimitDescriptor>
    getDescriptorsList()
    The rate limit descriptor list to use in the rate limit service request.
    RateLimitDescriptorOrBuilder
    getDescriptorsOrBuilder(int index)
    The rate limit descriptor list to use in the rate limit service request.
    List<? extends RateLimitDescriptorOrBuilder>
    getDescriptorsOrBuilderList()
    The rate limit descriptor list to use in the rate limit service request.
    String
    getDomain()
    The rate limit domain to use in the rate limit service request.
    com.google.protobuf.ByteString
    getDomainBytes()
    The rate limit domain to use in the rate limit service request.
    boolean
    getFailureModeDeny()
    The filter's behaviour in case the rate limiting service does not respond back.
    RateLimitServiceConfig
    getRateLimitService()
    Configuration for an external rate limit service provider.
    RateLimitServiceConfigOrBuilder
    getRateLimitServiceOrBuilder()
    Configuration for an external rate limit service provider.
    String
    getStatPrefix()
    The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
    com.google.protobuf.Duration
    getTimeout()
    The timeout in milliseconds for the rate limit service RPC.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    The timeout in milliseconds for the rate limit service RPC.
    boolean
    hasRateLimitService()
    Configuration for an external rate limit service provider.
    boolean
    hasTimeout()
    The timeout in milliseconds for the rate limit service RPC.

    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

    • getStatPrefix

      String getStatPrefix()
       The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting :ref:`statistics <config_network_filters_rate_limit_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • getDomain

      String getDomain()
       The rate limit domain to use in the rate limit service request.
      string domain = 2 [(.validate.rules) = { ... }
      Returns:
      The domain.

    • getDomainBytes

      com.google.protobuf.ByteString getDomainBytes()
       The rate limit domain to use in the rate limit service request.
      string domain = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for domain.

    • getDescriptorsList

      List<RateLimitDescriptor> getDescriptorsList()
       The rate limit descriptor list to use in the rate limit service request.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

    • getDescriptors

      RateLimitDescriptor getDescriptors(int index)
       The rate limit descriptor list to use in the rate limit service request.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

    • getDescriptorsCount

      int getDescriptorsCount()
       The rate limit descriptor list to use in the rate limit service request.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

    • getDescriptorsOrBuilderList

      List<? extends RateLimitDescriptorOrBuilder> getDescriptorsOrBuilderList()
       The rate limit descriptor list to use in the rate limit service request.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

    • getDescriptorsOrBuilder

      RateLimitDescriptorOrBuilder getDescriptorsOrBuilder(int index)
       The rate limit descriptor list to use in the rate limit service request.
      repeated .envoy.extensions.common.ratelimit.v3.RateLimitDescriptor descriptors = 3 [(.validate.rules) = { ... }

    • hasTimeout

      boolean hasTimeout()
       The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
      .google.protobuf.Duration timeout = 4;
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
       The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
      .google.protobuf.Duration timeout = 4;
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
      .google.protobuf.Duration timeout = 4;

    • getFailureModeDeny

      boolean getFailureModeDeny()
       The filter's behaviour in case the rate limiting service does
 not respond back. When it is set to true, Envoy will not allow traffic in case of
 communication failure between rate limiting service and the proxy.
 Defaults to false.
      bool failure_mode_deny = 5;
      Returns:
      The failureModeDeny.

    • hasRateLimitService

      boolean hasRateLimitService()
       Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
      .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }
      Returns:
      Whether the rateLimitService field is set.

    • getRateLimitService

      RateLimitServiceConfig getRateLimitService()
       Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
      .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }
      Returns:
      The rateLimitService.

    • getRateLimitServiceOrBuilder

      RateLimitServiceConfigOrBuilder getRateLimitServiceOrBuilder()
       Configuration for an external rate limit service provider. If not
 specified, any calls to the rate limit service will immediately return
 success.
      .envoy.config.ratelimit.v3.RateLimitServiceConfig rate_limit_service = 6 [(.validate.rules) = { ... }