Class MetadataKey.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<MetadataKey.Builder>
-
- io.envoyproxy.envoy.type.metadata.v3.MetadataKey.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,MetadataKeyOrBuilder
,java.lang.Cloneable
- Enclosing class:
- MetadataKey
public static final class MetadataKey.Builder extends com.google.protobuf.GeneratedMessage.Builder<MetadataKey.Builder> implements MetadataKeyOrBuilder
MetadataKey provides a general interface using ``key`` 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 MetadataKey will retrieve a string value "bar" from the Metadata. .. code-block:: yaml key: envoy.xxx path: - key: prop - key: foo
Protobuf typeenvoy.type.metadata.v3.MetadataKey
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private java.lang.Object
key_
private java.util.List<MetadataKey.PathSegment>
path_
private com.google.protobuf.RepeatedFieldBuilder<MetadataKey.PathSegment,MetadataKey.PathSegment.Builder,MetadataKey.PathSegmentOrBuilder>
pathBuilder_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MetadataKey.Builder
addAllPath(java.lang.Iterable<? extends MetadataKey.PathSegment> values)
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(int index, 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.Builder
addPath(MetadataKey.PathSegment.Builder builderForValue)
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
build()
MetadataKey
buildPartial()
private void
buildPartial0(MetadataKey result)
private void
buildPartialRepeatedFields(MetadataKey result)
MetadataKey.Builder
clear()
MetadataKey.Builder
clearKey()
The key name of Metadata to retrieve the Struct from the metadata.MetadataKey.Builder
clearPath()
The path to retrieve the Value from the Struct.private void
ensurePathIsMutable()
MetadataKey
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.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.java.util.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.private com.google.protobuf.RepeatedFieldBuilder<MetadataKey.PathSegment,MetadataKey.PathSegment.Builder,MetadataKey.PathSegmentOrBuilder>
getPathFieldBuilder()
java.util.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.java.util.List<? extends MetadataKey.PathSegmentOrBuilder>
getPathOrBuilderList()
The path to retrieve the Value from the Struct.protected com.google.protobuf.GeneratedMessage.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
removePath(int index)
The path to retrieve the Value from the Struct.MetadataKey.Builder
setKey(java.lang.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 value)
The path to retrieve the Value from the Struct.MetadataKey.Builder
setPath(int index, MetadataKey.PathSegment.Builder builderForValue)
The path to retrieve the Value from the Struct.-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
bitField0_
private int bitField0_
-
key_
private java.lang.Object key_
-
path_
private java.util.List<MetadataKey.PathSegment> path_
-
pathBuilder_
private com.google.protobuf.RepeatedFieldBuilder<MetadataKey.PathSegment,MetadataKey.PathSegment.Builder,MetadataKey.PathSegmentOrBuilder> pathBuilder_
-
-
Method Detail
-
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.Builder<MetadataKey.Builder>
-
clear
public MetadataKey.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<MetadataKey.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<MetadataKey.Builder>
-
getDefaultInstanceForType
public MetadataKey getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public MetadataKey build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public MetadataKey buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartialRepeatedFields
private void buildPartialRepeatedFields(MetadataKey result)
-
buildPartial0
private void buildPartial0(MetadataKey result)
-
mergeFrom
public MetadataKey.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<MetadataKey.Builder>
-
mergeFrom
public MetadataKey.Builder mergeFrom(MetadataKey other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<MetadataKey.Builder>
-
mergeFrom
public MetadataKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<MetadataKey.Builder>
- Throws:
java.io.IOException
-
getKey
public java.lang.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) = { ... }
- Specified by:
getKey
in interfaceMetadataKeyOrBuilder
- Returns:
- The key.
-
getKeyBytes
public 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) = { ... }
- Specified by:
getKeyBytes
in interfaceMetadataKeyOrBuilder
- Returns:
- The bytes for key.
-
setKey
public MetadataKey.Builder setKey(java.lang.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) = { ... }
- Parameters:
value
- The key to set.- Returns:
- This builder for chaining.
-
clearKey
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) = { ... }
- Returns:
- This builder for chaining.
-
setKeyBytes
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) = { ... }
- Parameters:
value
- The bytes for key to set.- Returns:
- This builder for chaining.
-
ensurePathIsMutable
private void ensurePathIsMutable()
-
getPathList
public java.util.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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
- Specified by:
getPathList
in interfaceMetadataKeyOrBuilder
-
getPathCount
public 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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
- Specified by:
getPathCount
in interfaceMetadataKeyOrBuilder
-
getPath
public 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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
- Specified by:
getPath
in interfaceMetadataKeyOrBuilder
-
setPath
public 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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
setPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addAllPath
public MetadataKey.Builder addAllPath(java.lang.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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
clearPath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
removePath
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
getPathBuilder
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
getPathOrBuilder
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
- Specified by:
getPathOrBuilder
in interfaceMetadataKeyOrBuilder
-
getPathOrBuilderList
public java.util.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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
- Specified by:
getPathOrBuilderList
in interfaceMetadataKeyOrBuilder
-
addPathBuilder
public 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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
addPathBuilder
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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
getPathBuilderList
public java.util.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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
-
getPathFieldBuilder
private com.google.protobuf.RepeatedFieldBuilder<MetadataKey.PathSegment,MetadataKey.PathSegment.Builder,MetadataKey.PathSegmentOrBuilder> getPathFieldBuilder()
-
-