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

Interface RateLimitPerRouteOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDomain()
    Overrides the domain.
    com.google.protobuf.ByteString
    getDomainBytes()
    Overrides the domain.
    RateLimitPerRoute.OverrideOptions
    getOverrideOption()
    Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
    int
    getOverrideOptionValue()
    Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
    RateLimit
    getRateLimits(int index)
    Rate limit configuration that is used to generate a list of descriptor entries based on the request context.
    int
    getRateLimitsCount()
    Rate limit configuration that is used to generate a list of descriptor entries based on the request context.
    List<RateLimit>
    getRateLimitsList()
    Rate limit configuration that is used to generate a list of descriptor entries based on the request context.
    RateLimitOrBuilder
    getRateLimitsOrBuilder(int index)
    Rate limit configuration that is used to generate a list of descriptor entries based on the request context.
    List<? extends RateLimitOrBuilder>
    getRateLimitsOrBuilderList()
    Rate limit configuration that is used to generate a list of descriptor entries based on the request context.
    RateLimitPerRoute.VhRateLimitsOptions
    getVhRateLimits()
    Specifies if the rate limit filter should include the virtual host rate limits.
    int
    getVhRateLimitsValue()
    Specifies if the rate limit filter should include the virtual host rate limits.

    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

    • getVhRateLimitsValue

      int getVhRateLimitsValue()
       Specifies if the rate limit filter should include the virtual host rate limits.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
      .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.VhRateLimitsOptions vh_rate_limits = 1 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for vhRateLimits.

    • getVhRateLimits

      RateLimitPerRoute.VhRateLimitsOptions getVhRateLimits()
       Specifies if the rate limit filter should include the virtual host rate limits.
 [#next-major-version: unify with local ratelimit, should use common.ratelimit.v3.VhRateLimitsOptions instead.]
      .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.VhRateLimitsOptions vh_rate_limits = 1 [(.validate.rules) = { ... }
      Returns:
      The vhRateLimits.

    • getOverrideOptionValue

      int getOverrideOptionValue()
       Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
 [#not-implemented-hide:]
      .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions override_option = 2 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for overrideOption.

    • getOverrideOption

      RateLimitPerRoute.OverrideOptions getOverrideOption()
       Specifies if the rate limit filter should include the lower levels (route level, virtual host level or cluster weight level) rate limits override options.
 [#not-implemented-hide:]
      .envoy.extensions.filters.http.ratelimit.v3.RateLimitPerRoute.OverrideOptions override_option = 2 [(.validate.rules) = { ... }
      Returns:
      The overrideOption.

    • getRateLimitsList

      List<RateLimit> getRateLimitsList()
       Rate limit configuration that is used to generate a list of descriptor entries based on
 the request context. The generated entries will be used to find one or multiple matched rate
 limit rule from the ``descriptors``.
 If this is set, then
 :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>`,
 :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` and
 :ref:`RateLimit.rate_limits<envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimit.rate_limits>` fields
 will be ignored.

 .. note::
   Not all configuration fields of
   :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here.
   Following fields are not supported:

   1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`.
   2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`.
   3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`.
   4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
      repeated .envoy.config.route.v3.RateLimit rate_limits = 3;

    • getRateLimits

      RateLimit getRateLimits(int index)
       Rate limit configuration that is used to generate a list of descriptor entries based on
 the request context. The generated entries will be used to find one or multiple matched rate
 limit rule from the ``descriptors``.
 If this is set, then
 :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>`,
 :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` and
 :ref:`RateLimit.rate_limits<envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimit.rate_limits>` fields
 will be ignored.

 .. note::
   Not all configuration fields of
   :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here.
   Following fields are not supported:

   1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`.
   2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`.
   3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`.
   4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
      repeated .envoy.config.route.v3.RateLimit rate_limits = 3;

    • getRateLimitsCount

      int getRateLimitsCount()
       Rate limit configuration that is used to generate a list of descriptor entries based on
 the request context. The generated entries will be used to find one or multiple matched rate
 limit rule from the ``descriptors``.
 If this is set, then
 :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>`,
 :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` and
 :ref:`RateLimit.rate_limits<envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimit.rate_limits>` fields
 will be ignored.

 .. note::
   Not all configuration fields of
   :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here.
   Following fields are not supported:

   1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`.
   2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`.
   3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`.
   4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
      repeated .envoy.config.route.v3.RateLimit rate_limits = 3;

    • getRateLimitsOrBuilderList

      List<? extends RateLimitOrBuilder> getRateLimitsOrBuilderList()
       Rate limit configuration that is used to generate a list of descriptor entries based on
 the request context. The generated entries will be used to find one or multiple matched rate
 limit rule from the ``descriptors``.
 If this is set, then
 :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>`,
 :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` and
 :ref:`RateLimit.rate_limits<envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimit.rate_limits>` fields
 will be ignored.

 .. note::
   Not all configuration fields of
   :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here.
   Following fields are not supported:

   1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`.
   2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`.
   3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`.
   4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
      repeated .envoy.config.route.v3.RateLimit rate_limits = 3;

    • getRateLimitsOrBuilder

      RateLimitOrBuilder getRateLimitsOrBuilder(int index)
       Rate limit configuration that is used to generate a list of descriptor entries based on
 the request context. The generated entries will be used to find one or multiple matched rate
 limit rule from the ``descriptors``.
 If this is set, then
 :ref:`VirtualHost.rate_limits<envoy_v3_api_field_config.route.v3.VirtualHost.rate_limits>`,
 :ref:`RouteAction.rate_limits<envoy_v3_api_field_config.route.v3.RouteAction.rate_limits>` and
 :ref:`RateLimit.rate_limits<envoy_v3_api_field_extensions.filters.http.ratelimit.v3.RateLimit.rate_limits>` fields
 will be ignored.

 .. note::
   Not all configuration fields of
   :ref:`rate limit config <envoy_v3_api_msg_config.route.v3.RateLimit>` is supported at here.
   Following fields are not supported:

   1. :ref:`rate limit stage <envoy_v3_api_field_config.route.v3.RateLimit.stage>`.
   2. :ref:`dynamic metadata <envoy_v3_api_field_config.route.v3.RateLimit.Action.dynamic_metadata>`.
   3. :ref:`disable_key <envoy_v3_api_field_config.route.v3.RateLimit.disable_key>`.
   4. :ref:`override limit <envoy_v3_api_field_config.route.v3.RateLimit.limit>`.
      repeated .envoy.config.route.v3.RateLimit rate_limits = 3;

    • getDomain

      String getDomain()
       Overrides the domain. If not set, uses the filter-level domain instead.
      string domain = 4;
      Returns:
      The domain.

    • getDomainBytes

      com.google.protobuf.ByteString getDomainBytes()
       Overrides the domain. If not set, uses the filter-level domain instead.
      string domain = 4;
      Returns:
      The bytes for domain.