io.envoyproxy.envoy.api.v2.route

Class QueryParameterMatcher

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.route.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryParameterMatcher.Builder 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.
static class	QueryParameterMatcher.QueryParameterMatchSpecifierCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	PRESENT_MATCH_FIELD_NUMBER
static int	REGEX_FIELD_NUMBER
static int	STRING_MATCH_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static QueryParameterMatcher	getDefaultInstance()
QueryParameterMatcher	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<QueryParameterMatcher>	getParserForType()
boolean	getPresentMatch() Specifies whether a query parameter should be present.
QueryParameterMatcher.QueryParameterMatchSpecifierCase	getQueryParameterMatchSpecifierCase()
com.google.protobuf.BoolValue	getRegex() Deprecated.
com.google.protobuf.BoolValueOrBuilder	getRegexOrBuilder() Deprecated.
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getValue() Deprecated.
com.google.protobuf.ByteString	getValueBytes() Deprecated.
int	hashCode()
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()
static QueryParameterMatcher.Builder	newBuilder()
static QueryParameterMatcher.Builder	newBuilder(QueryParameterMatcher prototype)
QueryParameterMatcher.Builder	newBuilderForType()
protected QueryParameterMatcher.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static QueryParameterMatcher	parseDelimitedFrom(InputStream input)
static QueryParameterMatcher	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryParameterMatcher	parseFrom(byte[] data)
static QueryParameterMatcher	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryParameterMatcher	parseFrom(ByteBuffer data)
static QueryParameterMatcher	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryParameterMatcher	parseFrom(com.google.protobuf.ByteString data)
static QueryParameterMatcher	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryParameterMatcher	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryParameterMatcher	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryParameterMatcher	parseFrom(InputStream input)
static QueryParameterMatcher	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryParameterMatcher>	parser()
QueryParameterMatcher.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

REGEX_FIELD_NUMBER

public static final int REGEX_FIELD_NUMBER

See Also:

Constant Field Values

STRING_MATCH_FIELD_NUMBER

public static final int STRING_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

PRESENT_MATCH_FIELD_NUMBER

public static final int PRESENT_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

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

getQueryParameterMatchSpecifierCase

public QueryParameterMatcher.QueryParameterMatchSpecifierCase getQueryParameterMatchSpecifierCase()

Specified by:

getQueryParameterMatchSpecifierCase in interface QueryParameterMatcherOrBuilder

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

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

getValue

@Deprecated
public String getValue()

Deprecated.

 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

getValueBytes

@Deprecated
public com.google.protobuf.ByteString getValueBytes()

Deprecated.

 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

hasRegex

@Deprecated
public boolean hasRegex()

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:

hasRegex in interface QueryParameterMatcherOrBuilder

getRegex

@Deprecated
public com.google.protobuf.BoolValue getRegex()

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:

getRegex in interface QueryParameterMatcherOrBuilder

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

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

getStringMatchOrBuilder

public StringMatcherOrBuilder getStringMatchOrBuilder()

 Specifies whether a query parameter value should match against a string.
 

.envoy.type.matcher.StringMatcher string_match = 5 [(.validate.rules) = { ... }

Specified by:

getStringMatchOrBuilder in interface QueryParameterMatcherOrBuilder

getPresentMatch

public boolean getPresentMatch()

 Specifies whether a query parameter should be present.
 

bool present_match = 6;

Specified by:

getPresentMatch in interface QueryParameterMatcherOrBuilder

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

parseFrom

public static QueryParameterMatcher parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static QueryParameterMatcher parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryParameterMatcher parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryParameterMatcher parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static QueryParameterMatcher parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static QueryParameterMatcher parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public QueryParameterMatcher.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryParameterMatcher.Builder newBuilder()

newBuilder

public static QueryParameterMatcher.Builder newBuilder(QueryParameterMatcher prototype)

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

getDefaultInstance

public static QueryParameterMatcher getDefaultInstance()

parser

public static com.google.protobuf.Parser<QueryParameterMatcher> parser()

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