Package io.envoyproxy.envoy.config.accesslog.v3

Class MetadataFilter

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetadataFilterOrBuilder, Serializable
    public final class MetadataFilter
extends com.google.protobuf.GeneratedMessageV3
implements MetadataFilterOrBuilder
     Filters based on matching dynamic metadata.
 If the matcher path and key correspond to an existing key in dynamic
 metadata, the request is logged only if the matcher value is equal to the
 metadata value. If the matcher path and key *do not* correspond to an
 existing key in dynamic metadata, the request is logged only if
 match_if_key_not_found is "true" or unset.
    Protobuf type envoy.config.accesslog.v3.MetadataFilter
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MetadataFilter.Builder
      Filters based on matching dynamic metadata.

      • 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 MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER  
      static int MATCHER_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

    • Field Detail

      • MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER

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

      • hasMatcher

        public boolean hasMatcher()
         Matcher to check metadata for specified value. For example, to match on the
 access_log_hint metadata, set the filter to "envoy.common" and the path to
 "access_log_hint", and the value to "true".
        .envoy.type.matcher.v3.MetadataMatcher matcher = 1;
        Specified by:
        hasMatcher in interface MetadataFilterOrBuilder
        Returns:
        Whether the matcher field is set.

      • getMatcher

        public MetadataMatcher getMatcher()
         Matcher to check metadata for specified value. For example, to match on the
 access_log_hint metadata, set the filter to "envoy.common" and the path to
 "access_log_hint", and the value to "true".
        .envoy.type.matcher.v3.MetadataMatcher matcher = 1;
        Specified by:
        getMatcher in interface MetadataFilterOrBuilder
        Returns:
        The matcher.

      • getMatcherOrBuilder

        public MetadataMatcherOrBuilder getMatcherOrBuilder()
         Matcher to check metadata for specified value. For example, to match on the
 access_log_hint metadata, set the filter to "envoy.common" and the path to
 "access_log_hint", and the value to "true".
        .envoy.type.matcher.v3.MetadataMatcher matcher = 1;
        Specified by:
        getMatcherOrBuilder in interface MetadataFilterOrBuilder

      • hasMatchIfKeyNotFound

        public boolean hasMatchIfKeyNotFound()
         Default result if the key does not exist in dynamic metadata: if unset or
 true, then log; if false, then don't log.
        .google.protobuf.BoolValue match_if_key_not_found = 2;
        Specified by:
        hasMatchIfKeyNotFound in interface MetadataFilterOrBuilder
        Returns:
        Whether the matchIfKeyNotFound field is set.

      • getMatchIfKeyNotFound

        public com.google.protobuf.BoolValue getMatchIfKeyNotFound()
         Default result if the key does not exist in dynamic metadata: if unset or
 true, then log; if false, then don't log.
        .google.protobuf.BoolValue match_if_key_not_found = 2;
        Specified by:
        getMatchIfKeyNotFound in interface MetadataFilterOrBuilder
        Returns:
        The matchIfKeyNotFound.

      • getMatchIfKeyNotFoundOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getMatchIfKeyNotFoundOrBuilder()
         Default result if the key does not exist in dynamic metadata: if unset or
 true, then log; if false, then don't log.
        .google.protobuf.BoolValue match_if_key_not_found = 2;
        Specified by:
        getMatchIfKeyNotFoundOrBuilder in interface MetadataFilterOrBuilder

      • 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 MetadataFilter parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

        public MetadataFilter.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MetadataFilter.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MetadataFilter.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static MetadataFilter getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<MetadataFilter> 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 MetadataFilter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder