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

      All Methods Instance Methods Abstract Methods 
      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 getShareKey()
      Specifies that the token bucket used for rate limiting should be shared with other local_rate_limit filters with a matching :ref:`token_bucket <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.token_bucket>` and ``share_key`` configuration.
      com.google.protobuf.ByteString getShareKeyBytes()
      Specifies that the token bucket used for rate limiting should be shared with other local_rate_limit filters with a matching :ref:`token_bucket <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.token_bucket>` and ``share_key`` configuration.
      String getStatPrefix()
      The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
      com.google.protobuf.ByteString getStatPrefixBytes()
      The prefix to use when emitting :ref:`statistics <config_network_filters_local_rate_limit_stats>`.
      TokenBucket getTokenBucket()
      The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
      TokenBucketOrBuilder getTokenBucketOrBuilder()
      The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.
      boolean hasRuntimeEnabled()
      Runtime flag that controls whether the filter is enabled or not.
      boolean hasTokenBucket()
      The token bucket configuration to use for rate limiting connections that are processed by the filter's filter chain.

      • 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

      • getStatPrefix

        String getStatPrefix()
         The prefix to use when emitting :ref:`statistics
 <config_network_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_network_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 connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit, unless
   a shared rate limit is configured via :ref:`share_key <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.share_key>`.
 .. 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 connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit, unless
   a shared rate limit is configured via :ref:`share_key <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.share_key>`.
 .. 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 connections that are processed by the
 filter's filter chain. Each incoming connection processed by the filter consumes a single
 token. If the token is available, the connection will be allowed. If no tokens are available,
 the connection will be immediately closed.
 .. note::
   In the current implementation each filter and filter chain has an independent rate limit, unless
   a shared rate limit is configured via :ref:`share_key <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.share_key>`.
 .. 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;

      • getShareKey

        String getShareKey()
         Specifies that the token bucket used for rate limiting should be shared with other local_rate_limit filters
 with a matching :ref:`token_bucket <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.token_bucket>`
 and ``share_key`` configuration. All fields of ``token_bucket`` must match exactly for the token bucket to be shared. If this
 field is empty, this filter will not share a token bucket with any other filter.
        string share_key = 4;
        Returns:
        The shareKey.

      • getShareKeyBytes

        com.google.protobuf.ByteString getShareKeyBytes()
         Specifies that the token bucket used for rate limiting should be shared with other local_rate_limit filters
 with a matching :ref:`token_bucket <envoy_v3_api_field_extensions.filters.network.local_ratelimit.v3.LocalRateLimit.token_bucket>`
 and ``share_key`` configuration. All fields of ``token_bucket`` must match exactly for the token bucket to be shared. If this
 field is empty, this filter will not share a token bucket with any other filter.
        string share_key = 4;
        Returns:
        The bytes for shareKey.