envoy.type.matcher

Class Metadata.MetadataMatcher

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.type.matcher.Metadata.MetadataMatcher

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Metadata.MetadataMatcherOrBuilder, Serializable

Enclosing class:

Metadata

public static final class Metadata.MetadataMatcher
extends com.google.protobuf.GeneratedMessageV3
implements Metadata.MetadataMatcherOrBuilder

 MetadataMatcher provides a general interface to check if a given value is matched in
 :ref:`Metadata <envoy_api_msg_core.Metadata>`. It uses `filter` and `path` to retrieve the value
 from the Metadata and then check if it's matched to the specified value.
 For example, for the following Metadata:
 .. code-block:: yaml
    filter_metadata:
      envoy.filters.http.rbac:
        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
    filter: envoy.filters.http.rbac
    path:
    - key: a
    - key: b
    - key: c
    value:
      string_match:
        prefix: pr
 The following MetadataMatcher is matched as the code will match one of the string values in the
 list at the path [a, t].
 .. code-block:: yaml
    filter: envoy.filters.http.rbac
    path:
    - key: a
    - key: t
    value:
      list_match:
        one_of:
          string_match:
            exact: m
 An example use of MetadataMatcher is specifying additional metadata in envoy.filters.http.rbac to
 enforce access control based on dynamic metadata in a request. See :ref:`Permission
 <envoy_api_msg_config.rbac.v2alpha.Permission>` and :ref:`Principal
 <envoy_api_msg_config.rbac.v2alpha.Principal>`.
 

Protobuf type envoy.type.matcher.MetadataMatcher

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.MetadataMatcher.Builder MetadataMatcher provides a general interface to check if a given value is matched in :ref:`Metadata <envoy_api_msg_core.Metadata>`.
static class	Metadata.MetadataMatcher.PathSegment Specifies the segment in a path to retrieve value from Metadata.
static interface	Metadata.MetadataMatcher.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

Field Summary

Fields

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

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

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

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

getFilter

public String getFilter()

 The filter name to retrieve the Struct from the Metadata.
 

string filter = 1 [(.validate.rules) = { ... }

Specified by:

getFilter in interface Metadata.MetadataMatcherOrBuilder

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The filter name to retrieve the Struct from the Metadata.
 

string filter = 1 [(.validate.rules) = { ... }

Specified by:

getFilterBytes in interface Metadata.MetadataMatcherOrBuilder

getPathList

public List<Metadata.MetadataMatcher.PathSegment> getPathList()

 The path to retrieve the Value from the Struct.
 

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

Specified by:

getPathList in interface Metadata.MetadataMatcherOrBuilder

getPathOrBuilderList

public List<? extends Metadata.MetadataMatcher.PathSegmentOrBuilder> getPathOrBuilderList()

 The path to retrieve the Value from the Struct.
 

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

Specified by:

getPathOrBuilderList in interface Metadata.MetadataMatcherOrBuilder

getPathCount

public int getPathCount()

 The path to retrieve the Value from the Struct.
 

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

Specified by:

getPathCount in interface Metadata.MetadataMatcherOrBuilder

getPath

public Metadata.MetadataMatcher.PathSegment getPath(int index)

 The path to retrieve the Value from the Struct.
 

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

Specified by:

getPath in interface Metadata.MetadataMatcherOrBuilder

getPathOrBuilder

public Metadata.MetadataMatcher.PathSegmentOrBuilder getPathOrBuilder(int index)

 The path to retrieve the Value from the Struct.
 

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

Specified by:

getPathOrBuilder in interface Metadata.MetadataMatcherOrBuilder

hasValue

public boolean hasValue()

 The MetadataMatcher 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 Metadata.MetadataMatcherOrBuilder

getValue

public Value.ValueMatcher getValue()

 The MetadataMatcher 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 Metadata.MetadataMatcherOrBuilder

getValueOrBuilder

public Value.ValueMatcherOrBuilder getValueOrBuilder()

 The MetadataMatcher 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 Metadata.MetadataMatcherOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metadata.MetadataMatcher parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Metadata.MetadataMatcher parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Metadata.MetadataMatcher.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Metadata.MetadataMatcher.Builder newBuilder()

newBuilder

public static Metadata.MetadataMatcher.Builder newBuilder(Metadata.MetadataMatcher prototype)

toBuilder

public Metadata.MetadataMatcher.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Metadata.MetadataMatcher getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder