Package io.envoyproxy.envoy.config.route.v3

Interface RateLimit.Action.QueryParametersOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RateLimit.Action.QueryParameters, RateLimit.Action.QueryParameters.Builder
Enclosing class:
RateLimit.Action
public static interface RateLimit.Action.QueryParametersOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescriptorKey()
    The key to use when creating the rate limit descriptor entry.
    com.google.protobuf.ByteString
    getDescriptorKeyBytes()
    The key to use when creating the rate limit descriptor entry.
    String
    getQueryParameterName()
    The name of the query parameter to use for rate limiting.
    com.google.protobuf.ByteString
    getQueryParameterNameBytes()
    The name of the query parameter to use for rate limiting.
    boolean
    getSkipIfAbsent()
    Controls the behavior when the specified query parameter is not present in the request.

    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

    • getQueryParameterName

      String getQueryParameterName()
       The name of the query parameter to use for rate limiting. Value of this query parameter is used to populate
 the value of the descriptor entry for the descriptor_key.
      string query_parameter_name = 1 [(.validate.rules) = { ... }
      Returns:
      The queryParameterName.

    • getQueryParameterNameBytes

      com.google.protobuf.ByteString getQueryParameterNameBytes()
       The name of the query parameter to use for rate limiting. Value of this query parameter is used to populate
 the value of the descriptor entry for the descriptor_key.
      string query_parameter_name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for queryParameterName.

    • getDescriptorKey

      String getDescriptorKey()
       The key to use when creating the rate limit descriptor entry. This descriptor key will be used to identify the
 rate limit rule in the rate limiting service.
      string descriptor_key = 2 [(.validate.rules) = { ... }
      Returns:
      The descriptorKey.

    • getDescriptorKeyBytes

      com.google.protobuf.ByteString getDescriptorKeyBytes()
       The key to use when creating the rate limit descriptor entry. This descriptor key will be used to identify the
 rate limit rule in the rate limiting service.
      string descriptor_key = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for descriptorKey.

    • getSkipIfAbsent

      boolean getSkipIfAbsent()
       Controls the behavior when the specified query parameter is not present in the request.

 If set to ``false`` (default):

 * Envoy does **NOT** call the rate limiting service for this descriptor.
 * Useful if the query parameter is optional and you prefer to skip rate limiting when it's absent.

 If set to ``true``:

 * Envoy calls the rate limiting service but omits this descriptor if the query parameter is missing.
 * Useful if you want Envoy to enforce rate limiting even when the query parameter is not present.
      bool skip_if_absent = 3;
      Returns:
      The skipIfAbsent.