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 Details

    • 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.Builder<DynamicMetadataInput.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • getDefaultInstanceForType

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

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

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

      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • setField

      public DynamicMetadataInput.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • clearField

      public DynamicMetadataInput.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • clearOneof

      public DynamicMetadataInput.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • setRepeatedField

      public DynamicMetadataInput.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • addRepeatedField

      public DynamicMetadataInput.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • mergeFrom

      public DynamicMetadataInput.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DynamicMetadataInput.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.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:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DynamicMetadataInput.Builder>
      Throws:
      IOException
    • 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.
    • setFilter

      public DynamicMetadataInput.Builder setFilter(String value)
       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

      public DynamicMetadataInput.Builder clearFilter()
       The filter name to retrieve the Struct from the Metadata.
       
      string filter = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.
    • setFilterBytes

      public DynamicMetadataInput.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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

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

       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

       The path to retrieve the Value from the Struct.
       
      repeated .envoy.extensions.matching.common_inputs.network.v3.DynamicMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
    • clearPath

      public DynamicMetadataInput.Builder 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

      public DynamicMetadataInput.Builder removePath(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) = { ... }
    • getPathBuilder

      public DynamicMetadataInput.PathSegment.Builder getPathBuilder(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) = { ... }
    • 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
    • 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
    • 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

      public DynamicMetadataInput.PathSegment.Builder addPathBuilder(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) = { ... }
    • getPathBuilderList

      public List<DynamicMetadataInput.PathSegment.Builder> 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:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>
    • mergeUnknownFields

      public final DynamicMetadataInput.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DynamicMetadataInput.Builder>