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
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 ClassesModifier and TypeClassDescriptionstatic final class
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>, 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
FieldsModifier and TypeFieldDescriptionprivate int
private static final MetadataFilter
static final int
private MetadataMatcher
static final int
private com.google.protobuf.BoolValue
private byte
private static final com.google.protobuf.Parser
<MetadataFilter> private static final long
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
MetadataFilter
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static MetadataFilter
static final com.google.protobuf.Descriptors.Descriptor
Matcher to check metadata for specified value.Matcher to check metadata for specified value.com.google.protobuf.BoolValue
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
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> int
int
hashCode()
boolean
Matcher to check metadata for specified value.boolean
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
final boolean
static MetadataFilter.Builder
static MetadataFilter.Builder
newBuilder
(MetadataFilter prototype) 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()
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 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_
-
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
-
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() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.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 interfaceMetadataFilterOrBuilder
- Returns:
- Whether the matcher field is set.
-
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 interfaceMetadataFilterOrBuilder
- Returns:
- The matcher.
-
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 interfaceMetadataFilterOrBuilder
-
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 interfaceMetadataFilterOrBuilder
- 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 interfaceMetadataFilterOrBuilder
- 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 interfaceMetadataFilterOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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
- Throws:
IOException
-
parseFrom
public static MetadataFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected MetadataFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-