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, java.io.Serializable
    public final class MetadataFilter
extends com.google.protobuf.GeneratedMessage
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.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private MetadataFilter()  
      private MetadataFilter​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static MetadataFilter getDefaultInstance()  
      MetadataFilter getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      MetadataMatcher getMatcher()
      Matcher to check metadata for specified value.
      MetadataMatcherOrBuilder getMatcherOrBuilder()
      Matcher to check metadata for specified value.
      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.
      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.
      com.google.protobuf.Parser<MetadataFilter> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      boolean hasMatcher()
      Matcher to check metadata for specified value.
      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.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MetadataFilter.Builder newBuilder()  
      static MetadataFilter.Builder newBuilder​(MetadataFilter prototype)  
      MetadataFilter.Builder newBuilderForType()  
      protected MetadataFilter.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static MetadataFilter parseDelimitedFrom​(java.io.InputStream input)  
      static MetadataFilter parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetadataFilter parseFrom​(byte[] data)  
      static MetadataFilter parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetadataFilter parseFrom​(com.google.protobuf.ByteString data)  
      static MetadataFilter parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetadataFilter parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MetadataFilter parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetadataFilter parseFrom​(java.io.InputStream input)  
      static MetadataFilter parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MetadataFilter parseFrom​(java.nio.ByteBuffer data)  
      static MetadataFilter parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MetadataFilter> parser()  
      MetadataFilter.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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, getUnknownFields, hasField, hasOneof

    • Field Detail

      • bitField0_

        private int bitField0_

      • MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER

        public static final int MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • matchIfKeyNotFound_

        private com.google.protobuf.BoolValue matchIfKeyNotFound_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final MetadataFilter DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<MetadataFilter> PARSER

    • Constructor Detail

      • MetadataFilter

        private MetadataFilter​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • MetadataFilter

        private MetadataFilter()

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • 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.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MetadataFilter parseFrom​(java.nio.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​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static MetadataFilter parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static MetadataFilter parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MetadataFilter parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MetadataFilter parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • 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.GeneratedMessage

      • getDefaultInstanceForType

        public MetadataFilter getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder