public static final class MetadataKey.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder> implements MetadataKeyOrBuilder
MetadataKey provides a general interface using `key` and `path` to retrieve value from
:ref:`Metadata <envoy_api_msg_core.Metadata>`.
For example, for the following Metadata:
.. code-block:: yaml
filter_metadata:
envoy.xxx:
prop:
foo: bar
xyz:
hello: envoy
The following MetadataKey will retrieve a string value "bar" from the Metadata.
.. code-block:: yaml
key: envoy.xxx
path:
- key: prop
- key: foo
Protobuf type envoy.type.metadata.v2.MetadataKey| Modifier and Type | Method and Description |
|---|---|
MetadataKey.Builder |
addAllPath(Iterable<? extends MetadataKey.PathSegment> values)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
addPath(int index,
MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
addPath(int index,
MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
addPath(MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
addPath(MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct.
|
MetadataKey.PathSegment.Builder |
addPathBuilder()
The path to retrieve the Value from the Struct.
|
MetadataKey.PathSegment.Builder |
addPathBuilder(int index)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
MetadataKey |
build() |
MetadataKey |
buildPartial() |
MetadataKey.Builder |
clear() |
MetadataKey.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
MetadataKey.Builder |
clearKey()
The key name of Metadata to retrieve the Struct from the metadata.
|
MetadataKey.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
MetadataKey.Builder |
clearPath()
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
clone() |
MetadataKey |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getKey()
The key name of Metadata to retrieve the Struct from the metadata.
|
com.google.protobuf.ByteString |
getKeyBytes()
The key name of Metadata to retrieve the Struct from the metadata.
|
MetadataKey.PathSegment |
getPath(int index)
The path to retrieve the Value from the Struct.
|
MetadataKey.PathSegment.Builder |
getPathBuilder(int index)
The path to retrieve the Value from the Struct.
|
List<MetadataKey.PathSegment.Builder> |
getPathBuilderList()
The path to retrieve the Value from the Struct.
|
int |
getPathCount()
The path to retrieve the Value from the Struct.
|
List<MetadataKey.PathSegment> |
getPathList()
The path to retrieve the Value from the Struct.
|
MetadataKey.PathSegmentOrBuilder |
getPathOrBuilder(int index)
The path to retrieve the Value from the Struct.
|
List<? extends MetadataKey.PathSegmentOrBuilder> |
getPathOrBuilderList()
The path to retrieve the Value from the Struct.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
MetadataKey.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
MetadataKey.Builder |
mergeFrom(com.google.protobuf.Message other) |
MetadataKey.Builder |
mergeFrom(MetadataKey other) |
MetadataKey.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
MetadataKey.Builder |
removePath(int index)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
MetadataKey.Builder |
setKey(String value)
The key name of Metadata to retrieve the Struct from the metadata.
|
MetadataKey.Builder |
setKeyBytes(com.google.protobuf.ByteString value)
The key name of Metadata to retrieve the Struct from the metadata.
|
MetadataKey.Builder |
setPath(int index,
MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
setPath(int index,
MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct.
|
MetadataKey.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
MetadataKey.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic MetadataKey build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic MetadataKey buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic MetadataKey.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataKey.Builder>public MetadataKey.Builder mergeFrom(MetadataKey other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public MetadataKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataKey.Builder>IOExceptionpublic String getKey()
The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.
string key = 1 [(.validate.rules) = { ... }getKey in interface MetadataKeyOrBuilderpublic com.google.protobuf.ByteString getKeyBytes()
The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.
string key = 1 [(.validate.rules) = { ... }getKeyBytes in interface MetadataKeyOrBuilderpublic MetadataKey.Builder setKey(String value)
The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.
string key = 1 [(.validate.rules) = { ... }public MetadataKey.Builder clearKey()
The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.
string key = 1 [(.validate.rules) = { ... }public MetadataKey.Builder setKeyBytes(com.google.protobuf.ByteString value)
The key name of Metadata to retrieve the Struct from the metadata. Typically, it represents a builtin subsystem or custom extension.
string key = 1 [(.validate.rules) = { ... }public List<MetadataKey.PathSegment> getPathList()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }getPathList in interface MetadataKeyOrBuilderpublic int getPathCount()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }getPathCount in interface MetadataKeyOrBuilderpublic MetadataKey.PathSegment getPath(int index)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }getPath in interface MetadataKeyOrBuilderpublic MetadataKey.Builder setPath(int index, MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder setPath(int index, MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder addPath(MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder addPath(int index, MetadataKey.PathSegment value)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder addPath(MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder addPath(int index, MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder addAllPath(Iterable<? extends MetadataKey.PathSegment> values)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder clearPath()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.Builder removePath(int index)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.PathSegment.Builder getPathBuilder(int index)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.PathSegmentOrBuilder getPathOrBuilder(int index)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }getPathOrBuilder in interface MetadataKeyOrBuilderpublic List<? extends MetadataKey.PathSegmentOrBuilder> getPathOrBuilderList()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }getPathOrBuilderList in interface MetadataKeyOrBuilderpublic MetadataKey.PathSegment.Builder addPathBuilder()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public MetadataKey.PathSegment.Builder addPathBuilder(int index)
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public List<MetadataKey.PathSegment.Builder> getPathBuilderList()
The path to retrieve the Value from the Struct. It can be a prefix or a full path, e.g. ``[prop, xyz]`` for a struct or ``[prop, foo]`` for a string in the example, which depends on the particular scenario. Note: Due to that only the key type segment is supported, the path can not specify a list unless the list is the last segment.
repeated .envoy.type.metadata.v2.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }public final MetadataKey.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>public final MetadataKey.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<MetadataKey.Builder>Copyright © 2018–2021 The Envoy Project. All rights reserved.