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

Interface ReverseConnectionClusterConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReverseConnectionClusterConfig, ReverseConnectionClusterConfig.Builder
public interface ReverseConnectionClusterConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getCleanupInterval()
    Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
    com.google.protobuf.DurationOrBuilder
    getCleanupIntervalOrBuilder()
    Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
    String
    getHostIdFormat()
    Host identifier format string.
    com.google.protobuf.ByteString
    getHostIdFormatBytes()
    Host identifier format string.
    boolean
    hasCleanupInterval()
    Time interval after which Envoy removes unused dynamic hosts created for reverse connections.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasCleanupInterval

      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) = { ... }
      Returns:
      Whether the cleanupInterval field is set.

    • getCleanupInterval

      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) = { ... }
      Returns:
      The cleanupInterval.

    • getCleanupIntervalOrBuilder

      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) = { ... }

    • getHostIdFormat

      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) = { ... }
      Returns:
      The hostIdFormat.

    • getHostIdFormatBytes

      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) = { ... }
      Returns:
      The bytes for hostIdFormat.