io.envoyproxy.envoy.config.common.matcher.v4alpha

Class Matcher

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.common.matcher.v4alpha.Matcher

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MatcherOrBuilder, Serializable

public final class Matcher
extends com.google.protobuf.GeneratedMessageV3
implements MatcherOrBuilder

 A matcher, which may traverse a matching tree in order to result in a match action.
 During matching, the tree will be traversed until a match is found, or if no match
 is found the action specified by the most specific on_no_match will be evaluated.
 As an on_no_match might result in another matching tree being evaluated, this process
 might repeat several times until the final OnMatch (or no match) is decided.
 This API is a work in progress.
 

Protobuf type envoy.config.common.matcher.v4alpha.Matcher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Matcher.Builder A matcher, which may traverse a matching tree in order to result in a match action.
static class	Matcher.MatcherList A linear list of field matchers.
static interface	Matcher.MatcherListOrBuilder
static class	Matcher.MatcherTree Protobuf type envoy.config.common.matcher.v4alpha.Matcher.MatcherTree
static interface	Matcher.MatcherTreeOrBuilder
static class	Matcher.MatcherTypeCase
static class	Matcher.OnMatch What to do if a match is successful.
static interface	Matcher.OnMatchOrBuilder

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	MATCHER_LIST_FIELD_NUMBER
static int	MATCHER_TREE_FIELD_NUMBER
static int	ON_NO_MATCH_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 Matcher	getDefaultInstance()
Matcher	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Matcher.MatcherList	getMatcherList() A linear list of matchers to evaluate.
Matcher.MatcherListOrBuilder	getMatcherListOrBuilder() A linear list of matchers to evaluate.
Matcher.MatcherTree	getMatcherTree() A match tree to evaluate.
Matcher.MatcherTreeOrBuilder	getMatcherTreeOrBuilder() A match tree to evaluate.
Matcher.MatcherTypeCase	getMatcherTypeCase()
Matcher.OnMatch	getOnNoMatch() Optional OnMatch to use if the matcher failed.
Matcher.OnMatchOrBuilder	getOnNoMatchOrBuilder() Optional OnMatch to use if the matcher failed.
com.google.protobuf.Parser<Matcher>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMatcherList() A linear list of matchers to evaluate.
boolean	hasMatcherTree() A match tree to evaluate.
boolean	hasOnNoMatch() Optional OnMatch to use if the matcher failed.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Matcher.Builder	newBuilder()
static Matcher.Builder	newBuilder(Matcher prototype)
Matcher.Builder	newBuilderForType()
protected Matcher.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Matcher	parseDelimitedFrom(InputStream input)
static Matcher	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Matcher	parseFrom(byte[] data)
static Matcher	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Matcher	parseFrom(ByteBuffer data)
static Matcher	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Matcher	parseFrom(com.google.protobuf.ByteString data)
static Matcher	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Matcher	parseFrom(com.google.protobuf.CodedInputStream input)
static Matcher	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Matcher	parseFrom(InputStream input)
static Matcher	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Matcher>	parser()
Matcher.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

MATCHER_LIST_FIELD_NUMBER

public static final int MATCHER_LIST_FIELD_NUMBER

See Also:

Constant Field Values

MATCHER_TREE_FIELD_NUMBER

public static final int MATCHER_TREE_FIELD_NUMBER

See Also:

Constant Field Values

ON_NO_MATCH_FIELD_NUMBER

public static final int ON_NO_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

getMatcherTypeCase

public Matcher.MatcherTypeCase getMatcherTypeCase()

Specified by:

getMatcherTypeCase in interface MatcherOrBuilder

hasMatcherList

public boolean hasMatcherList()

 A linear list of matchers to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherList matcher_list = 1;

Specified by:

hasMatcherList in interface MatcherOrBuilder

getMatcherList

public Matcher.MatcherList getMatcherList()

 A linear list of matchers to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherList matcher_list = 1;

Specified by:

getMatcherList in interface MatcherOrBuilder

getMatcherListOrBuilder

public Matcher.MatcherListOrBuilder getMatcherListOrBuilder()

 A linear list of matchers to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherList matcher_list = 1;

Specified by:

getMatcherListOrBuilder in interface MatcherOrBuilder

hasMatcherTree

public boolean hasMatcherTree()

 A match tree to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherTree matcher_tree = 2;

Specified by:

hasMatcherTree in interface MatcherOrBuilder

getMatcherTree

public Matcher.MatcherTree getMatcherTree()

 A match tree to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherTree matcher_tree = 2;

Specified by:

getMatcherTree in interface MatcherOrBuilder

getMatcherTreeOrBuilder

public Matcher.MatcherTreeOrBuilder getMatcherTreeOrBuilder()

 A match tree to evaluate.
 

.envoy.config.common.matcher.v4alpha.Matcher.MatcherTree matcher_tree = 2;

Specified by:

getMatcherTreeOrBuilder in interface MatcherOrBuilder

hasOnNoMatch

public boolean hasOnNoMatch()

 Optional OnMatch to use if the matcher failed.
 If specified, the OnMatch is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
 

.envoy.config.common.matcher.v4alpha.Matcher.OnMatch on_no_match = 3;

Specified by:

hasOnNoMatch in interface MatcherOrBuilder

getOnNoMatch

public Matcher.OnMatch getOnNoMatch()

 Optional OnMatch to use if the matcher failed.
 If specified, the OnMatch is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
 

.envoy.config.common.matcher.v4alpha.Matcher.OnMatch on_no_match = 3;

Specified by:

getOnNoMatch in interface MatcherOrBuilder

getOnNoMatchOrBuilder

public Matcher.OnMatchOrBuilder getOnNoMatchOrBuilder()

 Optional OnMatch to use if the matcher failed.
 If specified, the OnMatch is used, and the matcher is considered
 to have matched.
 If not specified, the matcher is considered not to have matched.
 

.envoy.config.common.matcher.v4alpha.Matcher.OnMatch on_no_match = 3;

Specified by:

getOnNoMatchOrBuilder in interface MatcherOrBuilder

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 Matcher parseFrom(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Matcher parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Matcher parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Matcher.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Matcher.Builder newBuilder()

newBuilder

public static Matcher.Builder newBuilder(Matcher prototype)

toBuilder

public Matcher.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Matcher.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Matcher getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Matcher> 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 Matcher getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder