Package io.envoyproxy.envoy.extensions.matching.common_inputs.transport_socket.v3

Class LocalityMetadataInput.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<LocalityMetadataInput.Builder>
io.envoyproxy.envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityMetadataInputOrBuilder, Cloneable
Enclosing class:
LocalityMetadataInput
public static final class LocalityMetadataInput.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LocalityMetadataInput.Builder> implements LocalityMetadataInputOrBuilder
 Specifies that matching should be performed by the locality metadata.
 This input extracts metadata from the endpoint's locality for transport socket selection.
 The metadata is extracted using a filter and path specification similar to
 :ref:`DynamicMetadataInput <envoy_v3_api_msg_extensions.matching.common_inputs.network.v3.DynamicMetadataInput>`.

 Example: Extract a metadata value from locality for transport socket matching.

 .. code-block:: yaml

   typed_config:
     "@type": type.googleapis.com/envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput
     filter: "envoy.transport_socket_match"
     path:
       - key: "region"

 This configuration extracts the value at path ``["envoy.transport_socket_match"]["region"]``
 from the locality metadata for use in transport socket selection.

 [#extension: envoy.matching.inputs.locality_metadata]
Protobuf type envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput

  • 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<LocalityMetadataInput.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public LocalityMetadataInput.Builder mergeFrom(LocalityMetadataInput other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LocalityMetadataInput.Builder>

    • mergeFrom

      public LocalityMetadataInput.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<LocalityMetadataInput.Builder>
      Throws:
      IOException

    • getFilter

      public String getFilter()
       The filter name to retrieve the Struct from the locality metadata.
 If not specified, defaults to ``envoy.lb`` which is commonly used for load balancing metadata.
      string filter = 1;
      Specified by:
      getFilter in interface LocalityMetadataInputOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       The filter name to retrieve the Struct from the locality metadata.
 If not specified, defaults to ``envoy.lb`` which is commonly used for load balancing metadata.
      string filter = 1;
      Specified by:
      getFilterBytes in interface LocalityMetadataInputOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public LocalityMetadataInput.Builder setFilter(String value)
       The filter name to retrieve the Struct from the locality metadata.
 If not specified, defaults to ``envoy.lb`` which is commonly used for load balancing metadata.
      string filter = 1;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public LocalityMetadataInput.Builder clearFilter()
       The filter name to retrieve the Struct from the locality metadata.
 If not specified, defaults to ``envoy.lb`` which is commonly used for load balancing metadata.
      string filter = 1;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public LocalityMetadataInput.Builder setFilterBytes(com.google.protobuf.ByteString value)
       The filter name to retrieve the Struct from the locality metadata.
 If not specified, defaults to ``envoy.lb`` which is commonly used for load balancing metadata.
      string filter = 1;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getPathList

      public List<LocalityMetadataInput.PathSegment> getPathList()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathList in interface LocalityMetadataInputOrBuilder

    • getPathCount

      public int getPathCount()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathCount in interface LocalityMetadataInputOrBuilder

    • getPath

      public LocalityMetadataInput.PathSegment getPath(int index)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPath in interface LocalityMetadataInputOrBuilder

    • setPath

      public LocalityMetadataInput.Builder setPath(int index, LocalityMetadataInput.PathSegment value)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • setPath

      public LocalityMetadataInput.Builder setPath(int index, LocalityMetadataInput.PathSegment.Builder builderForValue)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addPath

      public LocalityMetadataInput.Builder addPath(LocalityMetadataInput.PathSegment value)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addPath

      public LocalityMetadataInput.Builder addPath(int index, LocalityMetadataInput.PathSegment value)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addPath

      public LocalityMetadataInput.Builder addPath(LocalityMetadataInput.PathSegment.Builder builderForValue)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addPath

      public LocalityMetadataInput.Builder addPath(int index, LocalityMetadataInput.PathSegment.Builder builderForValue)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addAllPath

      public LocalityMetadataInput.Builder addAllPath(Iterable<? extends LocalityMetadataInput.PathSegment> values)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • clearPath

      public LocalityMetadataInput.Builder clearPath()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • removePath

      public LocalityMetadataInput.Builder removePath(int index)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathBuilder

      public LocalityMetadataInput.PathSegment.Builder getPathBuilder(int index)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathOrBuilder

      public LocalityMetadataInput.PathSegmentOrBuilder getPathOrBuilder(int index)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathOrBuilder in interface LocalityMetadataInputOrBuilder

    • getPathOrBuilderList

      public List<? extends LocalityMetadataInput.PathSegmentOrBuilder> getPathOrBuilderList()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }
      Specified by:
      getPathOrBuilderList in interface LocalityMetadataInputOrBuilder

    • addPathBuilder

      public LocalityMetadataInput.PathSegment.Builder addPathBuilder()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • addPathBuilder

      public LocalityMetadataInput.PathSegment.Builder addPathBuilder(int index)
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • getPathBuilderList

      public List<LocalityMetadataInput.PathSegment.Builder> getPathBuilderList()
       The path to retrieve the Value from the Struct.
      repeated .envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput.PathSegment path = 2 [(.validate.rules) = { ... }

    • setUnknownFields

      public final LocalityMetadataInput.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<LocalityMetadataInput.Builder>

    • mergeUnknownFields

      public final LocalityMetadataInput.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<LocalityMetadataInput.Builder>