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

Class QueryParameterMatcher

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryParameterMatcherOrBuilder, Serializable
    public final class QueryParameterMatcher
extends com.google.protobuf.GeneratedMessageV3
implements QueryParameterMatcherOrBuilder
     Query parameter matching treats the query string of a request's :path header
 as an ampersand-separated list of keys and/or key=value elements.
 [#next-free-field: 7]
    Protobuf type envoy.api.v2.route.QueryParameterMatcher
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getName

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

      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface QueryParameterMatcherOrBuilder
        Returns:
        The bytes for name.

      • getValue

        @Deprecated
public String getValue()
        Deprecated.
        envoy.api.v2.route.QueryParameterMatcher.value is deprecated. See envoy/api/v2/route/route_components.proto;l=1609
         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];
        Specified by:
        getValue in interface QueryParameterMatcherOrBuilder
        Returns:
        The value.

      • getValueBytes

        @Deprecated
public com.google.protobuf.ByteString getValueBytes()
        Deprecated.
        envoy.api.v2.route.QueryParameterMatcher.value is deprecated. See envoy/api/v2/route/route_components.proto;l=1609
         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];
        Specified by:
        getValueBytes in interface QueryParameterMatcherOrBuilder
        Returns:
        The bytes for value.

      • hasRegex

        @Deprecated
public boolean hasRegex()
        Deprecated.
        envoy.api.v2.route.QueryParameterMatcher.regex is deprecated. See envoy/api/v2/route/route_components.proto;l=1618
         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];
        Specified by:
        hasRegex in interface QueryParameterMatcherOrBuilder
        Returns:
        Whether the regex field is set.

      • getRegex

        @Deprecated
public com.google.protobuf.BoolValue getRegex()
        Deprecated.
        envoy.api.v2.route.QueryParameterMatcher.regex is deprecated. See envoy/api/v2/route/route_components.proto;l=1618
         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];
        Specified by:
        getRegex in interface QueryParameterMatcherOrBuilder
        Returns:
        The regex.

      • getRegexOrBuilder

        @Deprecated
public 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];
        Specified by:
        getRegexOrBuilder in interface QueryParameterMatcherOrBuilder

      • hasStringMatch

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

      • getStringMatch

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

      • hasPresentMatch

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

      • getPresentMatch

        public boolean getPresentMatch()
         Specifies whether a query parameter should be present.
        bool present_match = 6;
        Specified by:
        getPresentMatch in interface QueryParameterMatcherOrBuilder
        Returns:
        The presentMatch.

      • 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 QueryParameterMatcher parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameterMatcher parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameterMatcher parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameterMatcher parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameterMatcher parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected QueryParameterMatcher.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<QueryParameterMatcher> 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 QueryParameterMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder