Package io.envoyproxy.envoy.type.matcher

Class StructMatcher

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.type.matcher.StructMatcher

All Implemented Interfaces:

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

public final class StructMatcher
extends com.google.protobuf.GeneratedMessageV3
implements StructMatcherOrBuilder

 StructMatcher provides a general interface to check if a given value is matched in
 google.protobuf.Struct. It uses `path` to retrieve the value
 from the struct and then check if it's matched to the specified value.
 For example, for the following Struct:
 .. code-block:: yaml
        fields:
          a:
            struct_value:
              fields:
                b:
                  struct_value:
                    fields:
                      c:
                        string_value: pro
                t:
                  list_value:
                    values:
                      - string_value: m
                      - string_value: n
 The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value "pro"
 from the Metadata which is matched to the specified prefix match.
 .. code-block:: yaml
    path:
    - key: a
    - key: b
    - key: c
    value:
      string_match:
        prefix: pr
 The following StructMatcher is matched as the code will match one of the string values in the
 list at the path [a, t].
 .. code-block:: yaml
    path:
    - key: a
    - key: t
    value:
      list_match:
        one_of:
          string_match:
            exact: m
 An example use of StructMatcher is to match metadata in envoy.v*.core.Node.
 

Protobuf type envoy.type.matcher.StructMatcher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StructMatcher.Builder	StructMatcher provides a general interface to check if a given value is matched in google.protobuf.Struct.
static class	StructMatcher.PathSegment	Specifies the segment in a path to retrieve value from Struct.
static interface	StructMatcher.PathSegmentOrBuilder

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

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	PATH_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	Description
boolean	equals(Object obj)
static StructMatcher	getDefaultInstance()
StructMatcher	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<StructMatcher>	getParserForType()
StructMatcher.PathSegment	getPath(int index)	The path to retrieve the Value from the Struct.
int	getPathCount()	The path to retrieve the Value from the Struct.
List<StructMatcher.PathSegment>	getPathList()	The path to retrieve the Value from the Struct.
StructMatcher.PathSegmentOrBuilder	getPathOrBuilder(int index)	The path to retrieve the Value from the Struct.
List<? extends StructMatcher.PathSegmentOrBuilder>	getPathOrBuilderList()	The path to retrieve the Value from the Struct.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
ValueMatcher	getValue()	The StructMatcher is matched if the value retrieved by path is matched to this value.
ValueMatcherOrBuilder	getValueOrBuilder()	The StructMatcher is matched if the value retrieved by path is matched to this value.
int	hashCode()
boolean	hasValue()	The StructMatcher is matched if the value retrieved by path is matched to this value.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StructMatcher.Builder	newBuilder()
static StructMatcher.Builder	newBuilder(StructMatcher prototype)
StructMatcher.Builder	newBuilderForType()
protected StructMatcher.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StructMatcher	parseDelimitedFrom(InputStream input)
static StructMatcher	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructMatcher	parseFrom(byte[] data)
static StructMatcher	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructMatcher	parseFrom(com.google.protobuf.ByteString data)
static StructMatcher	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructMatcher	parseFrom(com.google.protobuf.CodedInputStream input)
static StructMatcher	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructMatcher	parseFrom(InputStream input)
static StructMatcher	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructMatcher	parseFrom(ByteBuffer data)
static StructMatcher	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StructMatcher>	parser()
StructMatcher.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, isStringEmpty, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

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

getPathList

public List<StructMatcher.PathSegment> getPathList()

 The path to retrieve the Value from the Struct.
 

repeated .envoy.type.matcher.StructMatcher.PathSegment path = 2 [(.validate.rules) = { ... }

Specified by:

getPathList in interface StructMatcherOrBuilder

getPathOrBuilderList

public List<? extends StructMatcher.PathSegmentOrBuilder> getPathOrBuilderList()

 The path to retrieve the Value from the Struct.
 

repeated .envoy.type.matcher.StructMatcher.PathSegment path = 2 [(.validate.rules) = { ... }

Specified by:

getPathOrBuilderList in interface StructMatcherOrBuilder

getPathCount

public int getPathCount()

 The path to retrieve the Value from the Struct.
 

repeated .envoy.type.matcher.StructMatcher.PathSegment path = 2 [(.validate.rules) = { ... }

Specified by:

getPathCount in interface StructMatcherOrBuilder

getPath

public StructMatcher.PathSegment getPath(int index)

 The path to retrieve the Value from the Struct.
 

repeated .envoy.type.matcher.StructMatcher.PathSegment path = 2 [(.validate.rules) = { ... }

Specified by:

getPath in interface StructMatcherOrBuilder

getPathOrBuilder

public StructMatcher.PathSegmentOrBuilder getPathOrBuilder(int index)

 The path to retrieve the Value from the Struct.
 

repeated .envoy.type.matcher.StructMatcher.PathSegment path = 2 [(.validate.rules) = { ... }

Specified by:

getPathOrBuilder in interface StructMatcherOrBuilder

hasValue

public boolean hasValue()

 The StructMatcher is matched if the value retrieved by path is matched to this value.
 

.envoy.type.matcher.ValueMatcher value = 3 [(.validate.rules) = { ... }

Specified by:

hasValue in interface StructMatcherOrBuilder

Returns:

Whether the value field is set.

getValue

public ValueMatcher getValue()

 The StructMatcher is matched if the value retrieved by path is matched to this value.
 

.envoy.type.matcher.ValueMatcher value = 3 [(.validate.rules) = { ... }

Specified by:

getValue in interface StructMatcherOrBuilder

Returns:

The value.

getValueOrBuilder

public ValueMatcherOrBuilder getValueOrBuilder()

 The StructMatcher is matched if the value retrieved by path is matched to this value.
 

.envoy.type.matcher.ValueMatcher value = 3 [(.validate.rules) = { ... }

Specified by:

getValueOrBuilder in interface StructMatcherOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StructMatcher parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StructMatcher parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StructMatcher.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StructMatcher.Builder newBuilder()

newBuilder

public static StructMatcher.Builder newBuilder(StructMatcher prototype)

toBuilder

public StructMatcher.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StructMatcher getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder