Package io.envoyproxy.envoy.api.v2.route

Interface QueryParameterMatcherOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Specifies the name of a key that must be present in the requested *path*'s query string.
    com.google.protobuf.ByteString
    getNameBytes()
    Specifies the name of a key that must be present in the requested *path*'s query string.
    boolean
    getPresentMatch()
    Specifies whether a query parameter should be present.
    QueryParameterMatcher.QueryParameterMatchSpecifierCase
    getQueryParameterMatchSpecifierCase()
     
    com.google.protobuf.BoolValue
    getRegex()
    Deprecated.
    envoy.api.v2.route.QueryParameterMatcher.regex is deprecated.
    com.google.protobuf.BoolValueOrBuilder
    getRegexOrBuilder()
    Deprecated.
    StringMatcher
    getStringMatch()
    Specifies whether a query parameter value should match against a string.
    StringMatcherOrBuilder
    getStringMatchOrBuilder()
    Specifies whether a query parameter value should match against a string.
    String
    getValue()
    Deprecated.
    envoy.api.v2.route.QueryParameterMatcher.value is deprecated.
    com.google.protobuf.ByteString
    getValueBytes()
    Deprecated.
    envoy.api.v2.route.QueryParameterMatcher.value is deprecated.
    boolean
    hasPresentMatch()
    Specifies whether a query parameter should be present.
    boolean
    hasRegex()
    Deprecated.
    envoy.api.v2.route.QueryParameterMatcher.regex is deprecated.
    boolean
    hasStringMatch()
    Specifies whether a query parameter value should match against a string.

    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

    • getName

      String getName()
       Specifies the name of a key that must be present in the requested
 *path*'s query string.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Specifies the name of a key that must be present in the requested
 *path*'s query string.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for name.

    • getValue

      @Deprecated String getValue()
      Deprecated.
      envoy.api.v2.route.QueryParameterMatcher.value is deprecated. See envoy/api/v2/route/route_components.proto;l=1610
       Specifies the value of the key. If the value is absent, a request
 that contains the key in its query string will match, whether the
 key appears with a value (e.g., "?debug=true") or not (e.g., "?debug")

 ..attention::
   This field is deprecated. Use an `exact` match inside the `string_match` field.
      string value = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
      Returns:
      The value.

    • getValueBytes

      @Deprecated com.google.protobuf.ByteString getValueBytes()
      Deprecated.
      envoy.api.v2.route.QueryParameterMatcher.value is deprecated. See envoy/api/v2/route/route_components.proto;l=1610
       Specifies the value of the key. If the value is absent, a request
 that contains the key in its query string will match, whether the
 key appears with a value (e.g., "?debug=true") or not (e.g., "?debug")

 ..attention::
   This field is deprecated. Use an `exact` match inside the `string_match` field.
      string value = 3 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
      Returns:
      The bytes for value.

    • hasRegex

      @Deprecated boolean hasRegex()
      Deprecated.
      envoy.api.v2.route.QueryParameterMatcher.regex is deprecated. See envoy/api/v2/route/route_components.proto;l=1619
       Specifies whether the query parameter value is a regular expression.
 Defaults to false. The entire query parameter value (i.e., the part to
 the right of the equals sign in "key=value") must match the regex.
 E.g., the regex ``\d+$`` will match *123* but not *a123* or *123a*.

 ..attention::
   This field is deprecated. Use a `safe_regex` match inside the `string_match` field.
      .google.protobuf.BoolValue regex = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
      Returns:
      Whether the regex field is set.

    • getRegex

      @Deprecated com.google.protobuf.BoolValue getRegex()
      Deprecated.
      envoy.api.v2.route.QueryParameterMatcher.regex is deprecated. See envoy/api/v2/route/route_components.proto;l=1619
       Specifies whether the query parameter value is a regular expression.
 Defaults to false. The entire query parameter value (i.e., the part to
 the right of the equals sign in "key=value") must match the regex.
 E.g., the regex ``\d+$`` will match *123* but not *a123* or *123a*.

 ..attention::
   This field is deprecated. Use a `safe_regex` match inside the `string_match` field.
      .google.protobuf.BoolValue regex = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
      Returns:
      The regex.

    • getRegexOrBuilder

      @Deprecated com.google.protobuf.BoolValueOrBuilder getRegexOrBuilder()
      Deprecated.
       Specifies whether the query parameter value is a regular expression.
 Defaults to false. The entire query parameter value (i.e., the part to
 the right of the equals sign in "key=value") must match the regex.
 E.g., the regex ``\d+$`` will match *123* but not *a123* or *123a*.

 ..attention::
   This field is deprecated. Use a `safe_regex` match inside the `string_match` field.
      .google.protobuf.BoolValue regex = 4 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];

    • hasStringMatch

      boolean hasStringMatch()
       Specifies whether a query parameter value should match against a string.
      .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the stringMatch field is set.

    • getStringMatch

      StringMatcher getStringMatch()
       Specifies whether a query parameter value should match against a string.
      .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }
      Returns:
      The stringMatch.

    • getStringMatchOrBuilder

      StringMatcherOrBuilder getStringMatchOrBuilder()
       Specifies whether a query parameter value should match against a string.
      .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }

    • hasPresentMatch

      boolean hasPresentMatch()
       Specifies whether a query parameter should be present.
      bool present_match = 6;
      Returns:
      Whether the presentMatch field is set.

    • getPresentMatch

      boolean getPresentMatch()
       Specifies whether a query parameter should be present.
      bool present_match = 6;
      Returns:
      The presentMatch.

    • getQueryParameterMatchSpecifierCase

      QueryParameterMatcher.QueryParameterMatchSpecifierCase getQueryParameterMatchSpecifierCase()