java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DynamicMetadataInputOrBuilder, Serializable

public final class DynamicMetadataInput extends com.google.protobuf.GeneratedMessageV3 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
See Also:
  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • getFilter

      public String getFilter()
       The filter name to retrieve the Struct from the Metadata.
       
      string filter = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilter in interface DynamicMetadataInputOrBuilder
      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:
      getFilterBytes in interface DynamicMetadataInputOrBuilder
      Returns:
      The bytes for filter.
    • getPathList

      public List<DynamicMetadataInput.PathSegment> 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:
      getPathList in interface DynamicMetadataInputOrBuilder
    • getPathOrBuilderList

      public List<? extends DynamicMetadataInput.PathSegmentOrBuilder> 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:
      getPathOrBuilderList in interface DynamicMetadataInputOrBuilder
    • 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:
      getPathCount in interface DynamicMetadataInputOrBuilder
    • getPath

      public DynamicMetadataInput.PathSegment getPath(int index)
       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:
      getPath in interface DynamicMetadataInputOrBuilder
    • getPathOrBuilder

      public DynamicMetadataInput.PathSegmentOrBuilder getPathOrBuilder(int index)
       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:
      getPathOrBuilder in interface DynamicMetadataInputOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • 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.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • 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 DynamicMetadataInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static DynamicMetadataInput parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static DynamicMetadataInput parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static DynamicMetadataInput.Builder newBuilder()
    • newBuilder

      public static DynamicMetadataInput.Builder newBuilder(DynamicMetadataInput prototype)
    • toBuilder

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

      protected DynamicMetadataInput.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static DynamicMetadataInput getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<DynamicMetadataInput> parser()
    • getParserForType

      public com.google.protobuf.Parser<DynamicMetadataInput> 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.GeneratedMessageV3
    • getDefaultInstanceForType

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