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

Class RateLimit.Action.QueryParameters

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.route.v3.RateLimit.Action.QueryParameters
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.QueryParametersOrBuilder, Serializable
Enclosing class:
RateLimit.Action
public static final class RateLimit.Action.QueryParameters extends com.google.protobuf.GeneratedMessageV3 implements RateLimit.Action.QueryParametersOrBuilder
 The following descriptor entry is appended when a query parameter contains a key that matches the
 ``query_parameter_name``:

 .. code-block:: cpp

   ("<descriptor_key>", "<query_parameter_value_queried_from_query_parameter>")
Protobuf type envoy.config.route.v3.RateLimit.Action.QueryParameters
See Also:

  • Field Details

    • QUERY_PARAMETER_NAME_FIELD_NUMBER

      public static final int QUERY_PARAMETER_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTOR_KEY_FIELD_NUMBER

      public static final int DESCRIPTOR_KEY_FIELD_NUMBER
      See Also:

    • SKIP_IF_ABSENT_FIELD_NUMBER

      public static final int SKIP_IF_ABSENT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getQueryParameterName

      public 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) = { ... }
      Specified by:
      getQueryParameterName in interface RateLimit.Action.QueryParametersOrBuilder
      Returns:
      The queryParameterName.

    • getQueryParameterNameBytes

      public 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) = { ... }
      Specified by:
      getQueryParameterNameBytes in interface RateLimit.Action.QueryParametersOrBuilder
      Returns:
      The bytes for queryParameterName.

    • getDescriptorKey

      public 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) = { ... }
      Specified by:
      getDescriptorKey in interface RateLimit.Action.QueryParametersOrBuilder
      Returns:
      The descriptorKey.

    • getDescriptorKeyBytes

      public 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) = { ... }
      Specified by:
      getDescriptorKeyBytes in interface RateLimit.Action.QueryParametersOrBuilder
      Returns:
      The bytes for descriptorKey.

    • getSkipIfAbsent

      public 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;
      Specified by:
      getSkipIfAbsent in interface RateLimit.Action.QueryParametersOrBuilder
      Returns:
      The skipIfAbsent.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimit.Action.QueryParameters parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RateLimit.Action.QueryParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RateLimit.Action.QueryParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RateLimit.Action.QueryParameters.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RateLimit.Action.QueryParameters.Builder newBuilder()

    • newBuilder

      public static RateLimit.Action.QueryParameters.Builder newBuilder(RateLimit.Action.QueryParameters prototype)

    • toBuilder

      public RateLimit.Action.QueryParameters.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RateLimit.Action.QueryParameters.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RateLimit.Action.QueryParameters getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RateLimit.Action.QueryParameters> parser()

    • getParserForType

      public com.google.protobuf.Parser<RateLimit.Action.QueryParameters> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RateLimit.Action.QueryParameters getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder