Package io.envoyproxy.envoy.type.metadata.v3

Class MetadataKey

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.type.metadata.v3.MetadataKey
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetadataKeyOrBuilder, Serializable
@Generated public final class MetadataKey extends com.google.protobuf.GeneratedMessage 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 type envoy.type.metadata.v3.MetadataKey
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MetadataKey.Builder
    MetadataKey provides a general interface using ``key`` and ``path`` to retrieve value from :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>`.
    static final class 
    MetadataKey.PathSegment
    Specifies the segment in a path to retrieve value from Metadata.
    static interface 
    MetadataKey.PathSegmentOrBuilder
     

    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

    Fields
    Modifier and Type
    Field
    Description
    private static final MetadataKey
    DEFAULT_INSTANCE
     
    private Object
    key_
     
    static final int
    KEY_FIELD_NUMBER
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<MetadataKey>
    PARSER
     
    private List<MetadataKey.PathSegment>
    path_
     
    static final int
    PATH_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    MetadataKey()
     
    private
    MetadataKey(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static MetadataKey
    getDefaultInstance()
     
    MetadataKey
    getDefaultInstanceForType()
     
    static final 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.
    com.google.protobuf.Parser<MetadataKey>
    getParserForType()
     
    MetadataKey.PathSegment
    getPath(int index)
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MetadataKey.Builder
    newBuilder()
     
    static MetadataKey.Builder
    newBuilder(MetadataKey prototype)
     
    MetadataKey.Builder
    newBuilderForType()
     
    protected MetadataKey.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MetadataKey
    parseDelimitedFrom(InputStream input)
     
    static MetadataKey
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataKey
    parseFrom(byte[] data)
     
    static MetadataKey
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataKey
    parseFrom(com.google.protobuf.ByteString data)
     
    static MetadataKey
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataKey
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MetadataKey
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataKey
    parseFrom(InputStream input)
     
    static MetadataKey
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MetadataKey
    parseFrom(ByteBuffer data)
     
    static MetadataKey
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MetadataKey>
    parser()
     
    MetadataKey.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Constructor Details

    • MetadataKey

      private MetadataKey(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • MetadataKey

      private MetadataKey()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getKey

      public 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 interface MetadataKeyOrBuilder
      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 interface MetadataKeyOrBuilder
      Returns:
      The bytes for key.

    • getPathList

      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.v3.MetadataKey.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathList in interface MetadataKeyOrBuilder

    • getPathOrBuilderList

      public 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 interface MetadataKeyOrBuilder

    • 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 interface MetadataKeyOrBuilder

    • 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 interface MetadataKeyOrBuilder

    • 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 interface MetadataKeyOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MetadataKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataKey parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataKey parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetadataKey parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetadataKey parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataKey parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataKey parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MetadataKey.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MetadataKey.Builder newBuilder()

    • newBuilder

      public static MetadataKey.Builder newBuilder(MetadataKey prototype)

    • toBuilder

      public MetadataKey.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MetadataKey.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MetadataKey getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MetadataKey> parser()

    • getParserForType

      public com.google.protobuf.Parser<MetadataKey> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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