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

Class QueryParameterMatcher.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryParameterMatcherOrBuilder, Cloneable
    Enclosing class:
    QueryParameterMatcher
    public static final class QueryParameterMatcher.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>
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

    • Method Detail

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

      • clear

        public QueryParameterMatcher.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<QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • getDefaultInstanceForType

        public QueryParameterMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • clearField

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • clearOneof

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • setRepeatedField

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • addRepeatedField

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • isInitialized

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

      • mergeFrom

        public QueryParameterMatcher.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<QueryParameterMatcher.Builder>
        Throws:
        IOException

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

      • setName

        public QueryParameterMatcher.Builder setName​(String value)
         Specifies the name of a key that must be present in the requested
 *path*'s query string.
        string name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public QueryParameterMatcher.Builder clearName()
         Specifies the name of a key that must be present in the requested
 *path*'s query string.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public QueryParameterMatcher.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Specifies the name of a key that must be present in the requested
 *path*'s query string.
        string name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setValue

        @Deprecated
public QueryParameterMatcher.Builder setValue​(String value)
        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];
        Parameters:
        value - The value to set.
        Returns:
        This builder for chaining.

      • clearValue

        @Deprecated
public QueryParameterMatcher.Builder clearValue()
        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];
        Returns:
        This builder for chaining.

      • setValueBytes

        @Deprecated
public QueryParameterMatcher.Builder setValueBytes​(com.google.protobuf.ByteString value)
        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];
        Parameters:
        value - The bytes for value to set.
        Returns:
        This builder for chaining.

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

      • setRegex

        @Deprecated
public QueryParameterMatcher.Builder setRegex​(com.google.protobuf.BoolValue value)
        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];

      • setRegex

        @Deprecated
public QueryParameterMatcher.Builder setRegex​(com.google.protobuf.BoolValue.Builder builderForValue)
        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];

      • mergeRegex

        @Deprecated
public QueryParameterMatcher.Builder mergeRegex​(com.google.protobuf.BoolValue value)
        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];

      • clearRegex

        @Deprecated
public QueryParameterMatcher.Builder clearRegex()
        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];

      • getRegexBuilder

        @Deprecated
public com.google.protobuf.BoolValue.Builder getRegexBuilder()
        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];

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

      • setStringMatch

        public QueryParameterMatcher.Builder setStringMatch​(StringMatcher value)
         Specifies whether a query parameter value should match against a string.
        .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }

      • setStringMatch

        public QueryParameterMatcher.Builder setStringMatch​(StringMatcher.Builder builderForValue)
         Specifies whether a query parameter value should match against a string.
        .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }

      • mergeStringMatch

        public QueryParameterMatcher.Builder mergeStringMatch​(StringMatcher value)
         Specifies whether a query parameter value should match against a string.
        .envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }

      • clearStringMatch

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

      • getStringMatchBuilder

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

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

      • setPresentMatch

        public QueryParameterMatcher.Builder setPresentMatch​(boolean value)
         Specifies whether a query parameter should be present.
        bool present_match = 6;
        Parameters:
        value - The presentMatch to set.
        Returns:
        This builder for chaining.

      • clearPresentMatch

        public QueryParameterMatcher.Builder clearPresentMatch()
         Specifies whether a query parameter should be present.
        bool present_match = 6;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final QueryParameterMatcher.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<QueryParameterMatcher.Builder>

      • mergeUnknownFields

        public final QueryParameterMatcher.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<QueryParameterMatcher.Builder>