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

Interface RateLimitConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RateLimitConfig, RateLimitConfig.Builder
    public interface RateLimitConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RateLimitConfig.Action getActions​(int index)
      A list of actions that are to be applied for this rate limit configuration.
      int getActionsCount()
      A list of actions that are to be applied for this rate limit configuration.
      java.util.List<RateLimitConfig.Action> getActionsList()
      A list of actions that are to be applied for this rate limit configuration.
      RateLimitConfig.ActionOrBuilder getActionsOrBuilder​(int index)
      A list of actions that are to be applied for this rate limit configuration.
      java.util.List<? extends RateLimitConfig.ActionOrBuilder> getActionsOrBuilderList()
      A list of actions that are to be applied for this rate limit configuration.
      java.lang.String getDisableKey()
      The key to be set in runtime to disable this rate limit configuration.
      com.google.protobuf.ByteString getDisableKeyBytes()
      The key to be set in runtime to disable this rate limit configuration.
      RateLimitConfig.Override getLimit()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.
      RateLimitConfig.OverrideOrBuilder getLimitOrBuilder()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.
      int getStage()
      Refers to the stage set in the filter.
      boolean hasLimit()
      An optional limit override to be appended to the descriptor produced by this rate limit configuration.

      • 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

      • getStage

        int getStage()
         Refers to the stage set in the filter. The rate limit configuration only
 applies to filters with the same stage number. The default stage number is
 0.
 .. note::
   The filter supports a range of 0 - 10 inclusively for stage numbers.
        uint32 stage = 1 [(.validate.rules) = { ... }
        Returns:
        The stage.

      • getDisableKey

        java.lang.String getDisableKey()
         The key to be set in runtime to disable this rate limit configuration.
        string disable_key = 2;
        Returns:
        The disableKey.

      • getDisableKeyBytes

        com.google.protobuf.ByteString getDisableKeyBytes()
         The key to be set in runtime to disable this rate limit configuration.
        string disable_key = 2;
        Returns:
        The bytes for disableKey.

      • getActionsList

        java.util.List<RateLimitConfig.Action> getActionsList()
         A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }

      • getActions

        RateLimitConfig.Action getActions​(int index)
         A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }

      • getActionsCount

        int getActionsCount()
         A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }

      • getActionsOrBuilderList

        java.util.List<? extends RateLimitConfig.ActionOrBuilder> getActionsOrBuilderList()
         A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }

      • getActionsOrBuilder

        RateLimitConfig.ActionOrBuilder getActionsOrBuilder​(int index)
         A list of actions that are to be applied for this rate limit configuration.
 Order matters as the actions are processed sequentially and the descriptor
 is composed by appending descriptor entries in that sequence. If an action
 cannot append a descriptor entry, no descriptor is generated for the
 configuration. See :ref:`composing actions
 <config_http_filters_rate_limit_composing_actions>` for additional documentation.
        repeated .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Action actions = 3 [(.validate.rules) = { ... }

      • hasLimit

        boolean hasLimit()
         An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;
        Returns:
        Whether the limit field is set.

      • getLimit

        RateLimitConfig.Override getLimit()
         An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;
        Returns:
        The limit.

      • getLimitOrBuilder

        RateLimitConfig.OverrideOrBuilder getLimitOrBuilder()
         An optional limit override to be appended to the descriptor produced by this
 rate limit configuration. If the override value is invalid or cannot be resolved
 from metadata, no override is provided. See :ref:`rate limit override
 <config_http_filters_rate_limit_rate_limit_override>` for more information.
        .envoy.extensions.filters.http.ratelimit.v3.RateLimitConfig.Override limit = 4;