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

Class RateLimit.Action.QueryParameters.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>
io.envoyproxy.envoy.config.route.v3.RateLimit.Action.QueryParameters.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RateLimit.Action.QueryParametersOrBuilder, Cloneable
Enclosing class:
RateLimit.Action.QueryParameters
public static final class RateLimit.Action.QueryParameters.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder> 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

  • Method Details

    • 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.Builder<RateLimit.Action.QueryParameters.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public RateLimit.Action.QueryParameters.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • clearField

      public RateLimit.Action.QueryParameters.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • clearOneof

      public RateLimit.Action.QueryParameters.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • setRepeatedField

      public RateLimit.Action.QueryParameters.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • addRepeatedField

      public RateLimit.Action.QueryParameters.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • mergeFrom

      public RateLimit.Action.QueryParameters.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.QueryParameters.Builder>

    • mergeFrom

      public RateLimit.Action.QueryParameters.Builder mergeFrom(RateLimit.Action.QueryParameters other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • mergeFrom

      public RateLimit.Action.QueryParameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RateLimit.Action.QueryParameters.Builder>
      Throws:
      IOException

    • 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.

    • setQueryParameterName

      public RateLimit.Action.QueryParameters.Builder setQueryParameterName(String value)
       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) = { ... }
      Parameters:
      value - The queryParameterName to set.
      Returns:
      This builder for chaining.

    • clearQueryParameterName

      public RateLimit.Action.QueryParameters.Builder clearQueryParameterName()
       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:
      This builder for chaining.

    • setQueryParameterNameBytes

      public RateLimit.Action.QueryParameters.Builder setQueryParameterNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for queryParameterName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDescriptorKey

      public RateLimit.Action.QueryParameters.Builder setDescriptorKey(String value)
       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) = { ... }
      Parameters:
      value - The descriptorKey to set.
      Returns:
      This builder for chaining.

    • clearDescriptorKey

      public RateLimit.Action.QueryParameters.Builder clearDescriptorKey()
       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:
      This builder for chaining.

    • setDescriptorKeyBytes

      public RateLimit.Action.QueryParameters.Builder setDescriptorKeyBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for descriptorKey to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSkipIfAbsent

      public RateLimit.Action.QueryParameters.Builder setSkipIfAbsent(boolean value)
       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;
      Parameters:
      value - The skipIfAbsent to set.
      Returns:
      This builder for chaining.

    • clearSkipIfAbsent

      public RateLimit.Action.QueryParameters.Builder clearSkipIfAbsent()
       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:
      This builder for chaining.

    • setUnknownFields

      public final RateLimit.Action.QueryParameters.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>

    • mergeUnknownFields

      public final RateLimit.Action.QueryParameters.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RateLimit.Action.QueryParameters.Builder>