Package io.envoyproxy.envoy.extensions.clusters.reverse_connection.v3

Class ReverseConnectionClusterConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.clusters.reverse_connection.v3.ReverseConnectionClusterConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReverseConnectionClusterConfigOrBuilder, Serializable
public final class ReverseConnectionClusterConfig extends com.google.protobuf.GeneratedMessageV3 implements ReverseConnectionClusterConfigOrBuilder
 Configuration for a cluster of type REVERSE_CONNECTION.
Protobuf type envoy.extensions.clusters.reverse_connection.v3.ReverseConnectionClusterConfig
See Also:

  • Field Details

    • CLEANUP_INTERVAL_FIELD_NUMBER

      public static final int CLEANUP_INTERVAL_FIELD_NUMBER
      See Also:

    • HOST_ID_FORMAT_FIELD_NUMBER

      public static final int HOST_ID_FORMAT_FIELD_NUMBER
      See Also:

  • 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

    • hasCleanupInterval

      public boolean hasCleanupInterval()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      hasCleanupInterval in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      Whether the cleanupInterval field is set.

    • getCleanupInterval

      public com.google.protobuf.Duration getCleanupInterval()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      getCleanupInterval in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The cleanupInterval.

    • getCleanupIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getCleanupIntervalOrBuilder()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      getCleanupIntervalOrBuilder in interface ReverseConnectionClusterConfigOrBuilder

    • getHostIdFormat

      public String getHostIdFormat()
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getHostIdFormat in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The hostIdFormat.

    • getHostIdFormatBytes

      public com.google.protobuf.ByteString getHostIdFormatBytes()
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getHostIdFormatBytes in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The bytes for hostIdFormat.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ReverseConnectionClusterConfig.Builder newBuilder()

    • newBuilder

      public static ReverseConnectionClusterConfig.Builder newBuilder(ReverseConnectionClusterConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ReverseConnectionClusterConfig getDefaultInstance()

    • parser

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

    • getParserForType

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