Package io.envoyproxy.envoy.extensions.filters.network.reverse_tunnel.v3

Interface ReverseTunnelOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAutoCloseConnections()
    Whether to automatically close connections after processing reverse tunnel requests
    com.google.protobuf.Duration
    getPingInterval()
    Ping interval for health checks on established reverse tunnel connections.
    com.google.protobuf.DurationOrBuilder
    getPingIntervalOrBuilder()
    Ping interval for health checks on established reverse tunnel connections.
    RequestMethod
    getRequestMethod()
    HTTP method to match for reverse tunnel requests.
    int
    getRequestMethodValue()
    HTTP method to match for reverse tunnel requests.
    String
    getRequestPath()
    HTTP path to match for reverse tunnel requests.
    com.google.protobuf.ByteString
    getRequestPathBytes()
    HTTP path to match for reverse tunnel requests.
    String
    getRequiredClusterName()
    Required cluster name for validating reverse tunnel connection initiations.
    com.google.protobuf.ByteString
    getRequiredClusterNameBytes()
    Required cluster name for validating reverse tunnel connection initiations.
    Validation
    getValidation()
    Optional validation configuration for node and cluster identifiers.
    ValidationOrBuilder
    getValidationOrBuilder()
    Optional validation configuration for node and cluster identifiers.
    boolean
    hasPingInterval()
    Ping interval for health checks on established reverse tunnel connections.
    boolean
    hasValidation()
    Optional validation configuration for node and cluster identifiers.

    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

    • hasPingInterval

      boolean hasPingInterval()
       Ping interval for health checks on established reverse tunnel connections.
 If not specified, defaults to ``2 seconds``.
      .google.protobuf.Duration ping_interval = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the pingInterval field is set.

    • getPingInterval

      com.google.protobuf.Duration getPingInterval()
       Ping interval for health checks on established reverse tunnel connections.
 If not specified, defaults to ``2 seconds``.
      .google.protobuf.Duration ping_interval = 1 [(.validate.rules) = { ... }
      Returns:
      The pingInterval.

    • getPingIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getPingIntervalOrBuilder()
       Ping interval for health checks on established reverse tunnel connections.
 If not specified, defaults to ``2 seconds``.
      .google.protobuf.Duration ping_interval = 1 [(.validate.rules) = { ... }

    • getAutoCloseConnections

      boolean getAutoCloseConnections()
       Whether to automatically close connections after processing reverse tunnel requests.

 * When set to ``true``, connections are closed after acceptance or rejection.
 * When set to ``false``, connections remain open for potential reuse.

 Defaults to ``false``.
      bool auto_close_connections = 2;
      Returns:
      The autoCloseConnections.

    • getRequestPath

      String getRequestPath()
       HTTP path to match for reverse tunnel requests.
 If not specified, defaults to ``/reverse_connections/request``.
      string request_path = 3 [(.validate.rules) = { ... }
      Returns:
      The requestPath.

    • getRequestPathBytes

      com.google.protobuf.ByteString getRequestPathBytes()
       HTTP path to match for reverse tunnel requests.
 If not specified, defaults to ``/reverse_connections/request``.
      string request_path = 3 [(.validate.rules) = { ... }
      Returns:
      The bytes for requestPath.

    • getRequestMethodValue

      int getRequestMethodValue()
       HTTP method to match for reverse tunnel requests.
 If not specified (``METHOD_UNSPECIFIED``), this defaults to ``GET``.
      .envoy.config.core.v3.RequestMethod request_method = 4 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for requestMethod.

    • getRequestMethod

      RequestMethod getRequestMethod()
       HTTP method to match for reverse tunnel requests.
 If not specified (``METHOD_UNSPECIFIED``), this defaults to ``GET``.
      .envoy.config.core.v3.RequestMethod request_method = 4 [(.validate.rules) = { ... }
      Returns:
      The requestMethod.

    • hasValidation

      boolean hasValidation()
       Optional validation configuration for node and cluster identifiers.
 If specified, the filter validates the ``x-envoy-reverse-tunnel-node-id`` and
 ``x-envoy-reverse-tunnel-cluster-id`` headers against expected values extracted
 using format strings. Requests that fail validation are rejected with HTTP ``403 Forbidden``.
      .envoy.extensions.filters.network.reverse_tunnel.v3.Validation validation = 5;
      Returns:
      Whether the validation field is set.

    • getValidation

      Validation getValidation()
       Optional validation configuration for node and cluster identifiers.
 If specified, the filter validates the ``x-envoy-reverse-tunnel-node-id`` and
 ``x-envoy-reverse-tunnel-cluster-id`` headers against expected values extracted
 using format strings. Requests that fail validation are rejected with HTTP ``403 Forbidden``.
      .envoy.extensions.filters.network.reverse_tunnel.v3.Validation validation = 5;
      Returns:
      The validation.

    • getValidationOrBuilder

      ValidationOrBuilder getValidationOrBuilder()
       Optional validation configuration for node and cluster identifiers.
 If specified, the filter validates the ``x-envoy-reverse-tunnel-node-id`` and
 ``x-envoy-reverse-tunnel-cluster-id`` headers against expected values extracted
 using format strings. Requests that fail validation are rejected with HTTP ``403 Forbidden``.
      .envoy.extensions.filters.network.reverse_tunnel.v3.Validation validation = 5;

    • getRequiredClusterName

      String getRequiredClusterName()
       Required cluster name for validating reverse tunnel connection initiations.
 When set, the filter validates that the upstream cluster of the initiator envoy matches this name
 via ``x-envoy-reverse-tunnel-upstream-cluster-name`` header. Connections with mismatched or missing
 cluster names are rejected with HTTP ``400 Bad Request``. When empty, no cluster name validation is performed.
      string required_cluster_name = 6 [(.validate.rules) = { ... }
      Returns:
      The requiredClusterName.

    • getRequiredClusterNameBytes

      com.google.protobuf.ByteString getRequiredClusterNameBytes()
       Required cluster name for validating reverse tunnel connection initiations.
 When set, the filter validates that the upstream cluster of the initiator envoy matches this name
 via ``x-envoy-reverse-tunnel-upstream-cluster-name`` header. Connections with mismatched or missing
 cluster names are rejected with HTTP ``400 Bad Request``. When empty, no cluster name validation is performed.
      string required_cluster_name = 6 [(.validate.rules) = { ... }
      Returns:
      The bytes for requiredClusterName.