Class MetadataFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.accesslog.v3.MetadataFilter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetadataFilterOrBuilder, Serializable
@Generated 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    private static final MetadataFilter
    DEFAULT_INSTANCE
     
    static final int
    MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER
     
    private MetadataMatcher
    matcher_
     
    static final int
    MATCHER_FIELD_NUMBER
     
    private com.google.protobuf.BoolValue
    matchIfKeyNotFound_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<MetadataFilter>
    PARSER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static MetadataFilter
    getDefaultInstance()
     
    MetadataFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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()
     
    final 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(InputStream input)
     
    static MetadataFilter
    parseDelimitedFrom(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(InputStream input)
     
    static MetadataFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataFilter
    parseFrom(ByteBuffer data)
     
    static MetadataFilter
    parseFrom(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

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • MATCHER_FIELD_NUMBER

      public static final int MATCHER_FIELD_NUMBER
      See Also:

    • matcher_

      private MetadataMatcher matcher_

    • MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER

      public static final int MATCH_IF_KEY_NOT_FOUND_FIELD_NUMBER
      See Also:

    • 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 Details

    • MetadataFilter

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

    • MetadataFilter

      private MetadataFilter()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static MetadataFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static MetadataFilter.Builder newBuilder()

    • newBuilder

      public static MetadataFilter.Builder newBuilder(MetadataFilter prototype)

    • 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