Package io.envoyproxy.envoy.extensions.filters.listener.local_ratelimit.v3

Interface LocalRateLimitOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    RuntimeFeatureFlag
    getRuntimeEnabled()
    Runtime flag that controls whether the filter is enabled or not.
    RuntimeFeatureFlagOrBuilder
    getRuntimeEnabledOrBuilder()
    Runtime flag that controls whether the filter is enabled or not.
    String
    getStatPrefix()
    The prefix to use when emitting :ref:`statistics <config_listener_filters_local_rate_limit_stats>`.
    com.google.protobuf.ByteString
    getStatPrefixBytes()
    The prefix to use when emitting :ref:`statistics <config_listener_filters_local_rate_limit_stats>`.
    TokenBucket
    getTokenBucket()
    The token bucket configuration to use for rate limiting all incoming sockets.
    TokenBucketOrBuilder
    getTokenBucketOrBuilder()
    The token bucket configuration to use for rate limiting all incoming sockets.
    boolean
    hasRuntimeEnabled()
    Runtime flag that controls whether the filter is enabled or not.
    boolean
    hasTokenBucket()
    The token bucket configuration to use for rate limiting all incoming sockets.

    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_listener_filters_local_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_listener_filters_local_rate_limit_stats>`.
      string stat_prefix = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for statPrefix.

    • hasTokenBucket

      boolean hasTokenBucket()
       The token bucket configuration to use for rate limiting all incoming sockets. If the token is available,
 the socket will be allowed. If no tokens are available, the socket will be immediately closed.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the tokenBucket field is set.

    • getTokenBucket

      TokenBucket getTokenBucket()
       The token bucket configuration to use for rate limiting all incoming sockets. If the token is available,
 the socket will be allowed. If no tokens are available, the socket will be immediately closed.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }
      Returns:
      The tokenBucket.

    • getTokenBucketOrBuilder

      TokenBucketOrBuilder getTokenBucketOrBuilder()
       The token bucket configuration to use for rate limiting all incoming sockets. If the token is available,
 the socket will be allowed. If no tokens are available, the socket will be immediately closed.

 .. note::
   In the current implementation the token bucket's :ref:`fill_interval
   <envoy_v3_api_field_type.v3.TokenBucket.fill_interval>` must be >= 50ms to avoid too aggressive
   refills.
      .envoy.type.v3.TokenBucket token_bucket = 2 [(.validate.rules) = { ... }

    • hasRuntimeEnabled

      boolean hasRuntimeEnabled()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;
      Returns:
      Whether the runtimeEnabled field is set.

    • getRuntimeEnabled

      RuntimeFeatureFlag getRuntimeEnabled()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;
      Returns:
      The runtimeEnabled.

    • getRuntimeEnabledOrBuilder

      RuntimeFeatureFlagOrBuilder getRuntimeEnabledOrBuilder()
       Runtime flag that controls whether the filter is enabled or not. If not specified, defaults
 to enabled.
      .envoy.config.core.v3.RuntimeFeatureFlag runtime_enabled = 3;