Class DynamicMetadataInput.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
io.envoyproxy.envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,DynamicMetadataInputOrBuilder,Cloneable
- Enclosing class:
- DynamicMetadataInput
public static final class DynamicMetadataInput.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
implements DynamicMetadataInputOrBuilder
Input that matches dynamic metadata by key.
DynamicMetadataInput provides a general interface using ``filter`` and ``path`` to retrieve value from
:ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`.
For example, for the following Metadata:
.. code-block:: yaml
filter_metadata:
envoy.xxx:
prop:
foo: bar
xyz:
hello: envoy
The following DynamicMetadataInput will retrieve a string value "bar" from the Metadata.
.. code-block:: yaml
filter: envoy.xxx
path:
- key: prop
- key: foo
[#extension: envoy.matching.inputs.dynamic_metadata]
Protobuf type envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput-
Method Summary
Modifier and TypeMethodDescriptionaddAllPath(Iterable<? extends DynamicMetadataInput.PathSegment> values) The path to retrieve the Value from the Struct.addPath(int index, DynamicMetadataInput.PathSegment value) The path to retrieve the Value from the Struct.addPath(int index, DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.The path to retrieve the Value from the Struct.addPath(DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.The path to retrieve the Value from the Struct.addPathBuilder(int index) The path to retrieve the Value from the Struct.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()clearField(com.google.protobuf.Descriptors.FieldDescriptor field) The filter name to retrieve the Struct from the Metadata.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) The path to retrieve the Value from the Struct.clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe filter name to retrieve the Struct from the Metadata.com.google.protobuf.ByteStringThe filter name to retrieve the Struct from the Metadata.getPath(int index) The path to retrieve the Value from the Struct.getPathBuilder(int index) The path to retrieve the Value from the Struct.The path to retrieve the Value from the Struct.intThe path to retrieve the Value from the Struct.The path to retrieve the Value from the Struct.getPathOrBuilder(int index) The path to retrieve the Value from the Struct.List<? extends DynamicMetadataInput.PathSegmentOrBuilder>The path to retrieve the Value from the Struct.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(DynamicMetadataInput other) mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removePath(int index) The path to retrieve the Value from the Struct.The filter name to retrieve the Struct from the Metadata.setFilterBytes(com.google.protobuf.ByteString value) The filter name to retrieve the Struct from the Metadata.setPath(int index, DynamicMetadataInput.PathSegment value) The path to retrieve the Value from the Struct.setPath(int index, DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
setField
public DynamicMetadataInput.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
clearField
public DynamicMetadataInput.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
clearOneof
public DynamicMetadataInput.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
setRepeatedField
public DynamicMetadataInput.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
addRepeatedField
public DynamicMetadataInput.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<DynamicMetadataInput.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
mergeFrom
public DynamicMetadataInput.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<DynamicMetadataInput.Builder>- Throws:
IOException
-
getFilter
The filter name to retrieve the Struct from the Metadata.
string filter = 1 [(.validate.rules) = { ... }- Specified by:
getFilterin interfaceDynamicMetadataInputOrBuilder- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()The filter name to retrieve the Struct from the Metadata.
string filter = 1 [(.validate.rules) = { ... }- Specified by:
getFilterBytesin interfaceDynamicMetadataInputOrBuilder- Returns:
- The bytes for filter.
-
setFilter
The filter name to retrieve the Struct from the Metadata.
string filter = 1 [(.validate.rules) = { ... }- Parameters:
value- The filter to set.- Returns:
- This builder for chaining.
-
clearFilter
The filter name to retrieve the Struct from the Metadata.
string filter = 1 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setFilterBytes
The filter name to retrieve the Struct from the Metadata.
string filter = 1 [(.validate.rules) = { ... }- Parameters:
value- The bytes for filter to set.- Returns:
- This builder for chaining.
-
getPathList
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }- Specified by:
getPathListin interfaceDynamicMetadataInputOrBuilder
-
getPathCount
public int getPathCount()The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }- Specified by:
getPathCountin interfaceDynamicMetadataInputOrBuilder
-
getPath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }- Specified by:
getPathin interfaceDynamicMetadataInputOrBuilder
-
setPath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
setPath
public DynamicMetadataInput.Builder setPath(int index, DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addPath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addPath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addPath
public DynamicMetadataInput.Builder addPath(DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addPath
public DynamicMetadataInput.Builder addPath(int index, DynamicMetadataInput.PathSegment.Builder builderForValue) The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addAllPath
public DynamicMetadataInput.Builder addAllPath(Iterable<? extends DynamicMetadataInput.PathSegment> values) The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
clearPath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
removePath
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
getPathBuilder
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
getPathOrBuilder
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }- Specified by:
getPathOrBuilderin interfaceDynamicMetadataInputOrBuilder
-
getPathOrBuilderList
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }- Specified by:
getPathOrBuilderListin interfaceDynamicMetadataInputOrBuilder
-
addPathBuilder
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
addPathBuilder
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
getPathBuilderList
The path to retrieve the Value from the Struct.
repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... } -
setUnknownFields
public final DynamicMetadataInput.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-
mergeUnknownFields
public final DynamicMetadataInput.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
-