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| Modifier and Type | Method and Description |
|---|---|
QueryParameterMatcher.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
QueryParameterMatcher |
build() |
QueryParameterMatcher |
buildPartial() |
QueryParameterMatcher.Builder |
clear() |
QueryParameterMatcher.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
QueryParameterMatcher.Builder |
clearName()
Specifies the name of a key that must be present in the requested
*path*'s query string.
|
QueryParameterMatcher.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
QueryParameterMatcher.Builder |
clearPresentMatch()
Specifies whether a query parameter should be present.
|
QueryParameterMatcher.Builder |
clearQueryParameterMatchSpecifier() |
QueryParameterMatcher.Builder |
clearRegex()
Deprecated.
|
QueryParameterMatcher.Builder |
clearStringMatch()
Specifies whether a query parameter value should match against a string.
|
QueryParameterMatcher.Builder |
clearValue()
Deprecated.
|
QueryParameterMatcher.Builder |
clone() |
QueryParameterMatcher |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
com.google.protobuf.BoolValue.Builder |
getRegexBuilder()
Deprecated.
|
com.google.protobuf.BoolValueOrBuilder |
getRegexOrBuilder()
Deprecated.
|
StringMatcher |
getStringMatch()
Specifies whether a query parameter value should match against a string.
|
StringMatcher.Builder |
getStringMatchBuilder()
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.
|
com.google.protobuf.ByteString |
getValueBytes()
Deprecated.
|
boolean |
hasRegex()
Deprecated.
|
boolean |
hasStringMatch()
Specifies whether a query parameter value should match against a string.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
QueryParameterMatcher.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
QueryParameterMatcher.Builder |
mergeFrom(com.google.protobuf.Message other) |
QueryParameterMatcher.Builder |
mergeFrom(QueryParameterMatcher other) |
QueryParameterMatcher.Builder |
mergeRegex(com.google.protobuf.BoolValue value)
Deprecated.
|
QueryParameterMatcher.Builder |
mergeStringMatch(StringMatcher value)
Specifies whether a query parameter value should match against a string.
|
QueryParameterMatcher.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
QueryParameterMatcher.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
QueryParameterMatcher.Builder |
setName(String value)
Specifies the name of a key that must be present in the requested
*path*'s query string.
|
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.
|
QueryParameterMatcher.Builder |
setPresentMatch(boolean value)
Specifies whether a query parameter should be present.
|
QueryParameterMatcher.Builder |
setRegex(com.google.protobuf.BoolValue.Builder builderForValue)
Deprecated.
|
QueryParameterMatcher.Builder |
setRegex(com.google.protobuf.BoolValue value)
Deprecated.
|
QueryParameterMatcher.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
QueryParameterMatcher.Builder |
setStringMatch(StringMatcher.Builder builderForValue)
Specifies whether a query parameter value should match against a string.
|
QueryParameterMatcher.Builder |
setStringMatch(StringMatcher value)
Specifies whether a query parameter value should match against a string.
|
QueryParameterMatcher.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
QueryParameterMatcher.Builder |
setValue(String value)
Deprecated.
|
QueryParameterMatcher.Builder |
setValueBytes(com.google.protobuf.ByteString value)
Deprecated.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic QueryParameterMatcher build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic QueryParameterMatcher buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic QueryParameterMatcher.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder mergeFrom(QueryParameterMatcher other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public QueryParameterMatcher.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryParameterMatcher.Builder>IOExceptionpublic QueryParameterMatcher.QueryParameterMatchSpecifierCase getQueryParameterMatchSpecifierCase()
getQueryParameterMatchSpecifierCase in interface QueryParameterMatcherOrBuilderpublic QueryParameterMatcher.Builder clearQueryParameterMatchSpecifier()
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) = { ... }getName in interface QueryParameterMatcherOrBuilderpublic 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) = { ... }getNameBytes in interface QueryParameterMatcherOrBuilderpublic 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) = { ... }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) = { ... }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) = { ... }@Deprecated public String getValue()
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];getValue in interface QueryParameterMatcherOrBuilder@Deprecated public com.google.protobuf.ByteString getValueBytes()
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];getValueBytes in interface QueryParameterMatcherOrBuilder@Deprecated public QueryParameterMatcher.Builder setValue(String value)
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];@Deprecated public QueryParameterMatcher.Builder clearValue()
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];@Deprecated public QueryParameterMatcher.Builder setValueBytes(com.google.protobuf.ByteString value)
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];@Deprecated public boolean hasRegex()
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];hasRegex in interface QueryParameterMatcherOrBuilder@Deprecated public com.google.protobuf.BoolValue getRegex()
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];getRegex in interface QueryParameterMatcherOrBuilder@Deprecated public QueryParameterMatcher.Builder setRegex(com.google.protobuf.BoolValue value)
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];@Deprecated public QueryParameterMatcher.Builder setRegex(com.google.protobuf.BoolValue.Builder builderForValue)
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];@Deprecated public QueryParameterMatcher.Builder mergeRegex(com.google.protobuf.BoolValue value)
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];@Deprecated public QueryParameterMatcher.Builder clearRegex()
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];@Deprecated public com.google.protobuf.BoolValue.Builder getRegexBuilder()
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];@Deprecated public com.google.protobuf.BoolValueOrBuilder getRegexOrBuilder()
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 in interface QueryParameterMatcherOrBuilderpublic boolean hasStringMatch()
Specifies whether a query parameter value should match against a string.
.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }hasStringMatch in interface QueryParameterMatcherOrBuilderpublic StringMatcher getStringMatch()
Specifies whether a query parameter value should match against a string.
.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }getStringMatch in interface QueryParameterMatcherOrBuilderpublic 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) = { ... }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) = { ... }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) = { ... }public QueryParameterMatcher.Builder clearStringMatch()
Specifies whether a query parameter value should match against a string.
.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }public StringMatcher.Builder getStringMatchBuilder()
Specifies whether a query parameter value should match against a string.
.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }public StringMatcherOrBuilder getStringMatchOrBuilder()
Specifies whether a query parameter value should match against a string.
.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }getStringMatchOrBuilder in interface QueryParameterMatcherOrBuilderpublic boolean getPresentMatch()
Specifies whether a query parameter should be present.
bool present_match = 6;getPresentMatch in interface QueryParameterMatcherOrBuilderpublic QueryParameterMatcher.Builder setPresentMatch(boolean value)
Specifies whether a query parameter should be present.
bool present_match = 6;public QueryParameterMatcher.Builder clearPresentMatch()
Specifies whether a query parameter should be present.
bool present_match = 6;public final QueryParameterMatcher.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>public final QueryParameterMatcher.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryParameterMatcher.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.