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

Class LocalityMetadataInput

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.matching.common_inputs.transport_socket.v3.LocalityMetadataInput
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityMetadataInputOrBuilder, Serializable
public final class LocalityMetadataInput extends com.google.protobuf.GeneratedMessageV3 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
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 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.

    • 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

    • 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

    • 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

    • 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

    • 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 LocalityMetadataInput parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static LocalityMetadataInput.Builder newBuilder()

    • newBuilder

      public static LocalityMetadataInput.Builder newBuilder(LocalityMetadataInput prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static LocalityMetadataInput getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<LocalityMetadataInput> 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 LocalityMetadataInput getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder