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

Class MetadataFilter.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetadataFilterOrBuilder, Cloneable
    Enclosing class:
    MetadataFilter
    public static final class MetadataFilter.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>
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

    • Method Detail

      • 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.Builder<MetadataFilter.Builder>

      • clear

        public MetadataFilter.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public MetadataFilter.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • setField

        public MetadataFilter.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • clearField

        public MetadataFilter.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • clearOneof

        public MetadataFilter.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • setRepeatedField

        public MetadataFilter.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • addRepeatedField

        public MetadataFilter.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • mergeFrom

        public MetadataFilter.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataFilter.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • mergeFrom

        public MetadataFilter.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataFilter.Builder>
        Throws:
        IOException

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

      • setMatcher

        public MetadataFilter.Builder setMatcher​(MetadataMatcher value)
         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;

      • setMatcher

        public MetadataFilter.Builder setMatcher​(MetadataMatcher.Builder builderForValue)
         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;

      • mergeMatcher

        public MetadataFilter.Builder mergeMatcher​(MetadataMatcher value)
         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;

      • clearMatcher

        public MetadataFilter.Builder clearMatcher()
         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;

      • getMatcherBuilder

        public MetadataMatcher.Builder getMatcherBuilder()
         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;

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

      • setMatchIfKeyNotFound

        public MetadataFilter.Builder setMatchIfKeyNotFound​(com.google.protobuf.BoolValue value)
         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;

      • setMatchIfKeyNotFound

        public MetadataFilter.Builder setMatchIfKeyNotFound​(com.google.protobuf.BoolValue.Builder builderForValue)
         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;

      • mergeMatchIfKeyNotFound

        public MetadataFilter.Builder mergeMatchIfKeyNotFound​(com.google.protobuf.BoolValue value)
         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;

      • clearMatchIfKeyNotFound

        public MetadataFilter.Builder clearMatchIfKeyNotFound()
         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;

      • getMatchIfKeyNotFoundBuilder

        public com.google.protobuf.BoolValue.Builder getMatchIfKeyNotFoundBuilder()
         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;

      • 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

      • setUnknownFields

        public final MetadataFilter.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>

      • mergeUnknownFields

        public final MetadataFilter.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataFilter.Builder>