Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.filters.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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      int getStage()
      Specifies the rate limit configuration stage.
      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 Detail

      • getDomain

        String getDomain()
         The rate limit domain to use in the rate limit service request.
        string domain = 1 [(.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 = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for domain.

      • getStage

        int getStage()
         Specifies the rate limit configuration stage. Each configured rate limit filter performs a
 rate limit check using descriptors configured in the
 :ref:`envoy_v3_api_msg_extensions.filters.network.thrift_proxy.v3.RouteAction` for the request.
 Only those entries with a matching stage number are used for a given filter. If not set, the
 default stage number is 0.
 .. note::
  The filter supports a range of 0 - 10 inclusively for stage numbers.
        uint32 stage = 2 [(.validate.rules) = { ... }
        Returns:
        The stage.

      • hasTimeout

        boolean hasTimeout()
         The timeout in milliseconds for the rate limit service RPC. If not
 set, this defaults to 20ms.
        .google.protobuf.Duration timeout = 3;
        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 = 3;
        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 = 3;

      • 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 = 4;
        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 = 5 [(.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 = 5 [(.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 = 5 [(.validate.rules) = { ... }