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

Class ReverseTunnel.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReverseTunnel.Builder>
io.envoyproxy.envoy.extensions.filters.network.reverse_tunnel.v3.ReverseTunnel.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReverseTunnelOrBuilder, Cloneable
Enclosing class:
ReverseTunnel
public static final class ReverseTunnel.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReverseTunnel.Builder> implements ReverseTunnelOrBuilder
 Configuration for the reverse tunnel network filter.
 This filter handles reverse tunnel connection acceptance and rejection by processing
 HTTP requests where required identification values are provided via HTTP headers.
 [#next-free-field: 7]
Protobuf type envoy.extensions.filters.network.reverse_tunnel.v3.ReverseTunnel

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public ReverseTunnel.Builder mergeFrom(ReverseTunnel other)

    • isInitialized

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

    • mergeFrom

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

    • hasPingInterval

      public 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) = { ... }
      Specified by:
      hasPingInterval in interface ReverseTunnelOrBuilder
      Returns:
      Whether the pingInterval field is set.

    • getPingInterval

      public 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) = { ... }
      Specified by:
      getPingInterval in interface ReverseTunnelOrBuilder
      Returns:
      The pingInterval.

    • setPingInterval

      public ReverseTunnel.Builder setPingInterval(com.google.protobuf.Duration value)
       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) = { ... }

    • setPingInterval

      public ReverseTunnel.Builder setPingInterval(com.google.protobuf.Duration.Builder builderForValue)
       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) = { ... }

    • mergePingInterval

      public ReverseTunnel.Builder mergePingInterval(com.google.protobuf.Duration value)
       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) = { ... }

    • clearPingInterval

      public ReverseTunnel.Builder clearPingInterval()
       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) = { ... }

    • getPingIntervalBuilder

      public com.google.protobuf.Duration.Builder getPingIntervalBuilder()
       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) = { ... }

    • getPingIntervalOrBuilder

      public 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) = { ... }
      Specified by:
      getPingIntervalOrBuilder in interface ReverseTunnelOrBuilder

    • getAutoCloseConnections

      public 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;
      Specified by:
      getAutoCloseConnections in interface ReverseTunnelOrBuilder
      Returns:
      The autoCloseConnections.

    • setAutoCloseConnections

      public ReverseTunnel.Builder setAutoCloseConnections(boolean value)
       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;
      Parameters:
      value - The autoCloseConnections to set.
      Returns:
      This builder for chaining.

    • clearAutoCloseConnections

      public ReverseTunnel.Builder clearAutoCloseConnections()
       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:
      This builder for chaining.

    • getRequestPath

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

    • getRequestPathBytes

      public 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) = { ... }
      Specified by:
      getRequestPathBytes in interface ReverseTunnelOrBuilder
      Returns:
      The bytes for requestPath.

    • setRequestPath

      public ReverseTunnel.Builder setRequestPath(String value)
       HTTP path to match for reverse tunnel requests.
 If not specified, defaults to ``/reverse_connections/request``.
      string request_path = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The requestPath to set.
      Returns:
      This builder for chaining.

    • clearRequestPath

      public ReverseTunnel.Builder clearRequestPath()
       HTTP path to match for reverse tunnel requests.
 If not specified, defaults to ``/reverse_connections/request``.
      string request_path = 3 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setRequestPathBytes

      public ReverseTunnel.Builder setRequestPathBytes(com.google.protobuf.ByteString value)
       HTTP path to match for reverse tunnel requests.
 If not specified, defaults to ``/reverse_connections/request``.
      string request_path = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for requestPath to set.
      Returns:
      This builder for chaining.

    • getRequestMethodValue

      public 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) = { ... }
      Specified by:
      getRequestMethodValue in interface ReverseTunnelOrBuilder
      Returns:
      The enum numeric value on the wire for requestMethod.

    • setRequestMethodValue

      public ReverseTunnel.Builder setRequestMethodValue(int value)
       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) = { ... }
      Parameters:
      value - The enum numeric value on the wire for requestMethod to set.
      Returns:
      This builder for chaining.

    • getRequestMethod

      public 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) = { ... }
      Specified by:
      getRequestMethod in interface ReverseTunnelOrBuilder
      Returns:
      The requestMethod.

    • setRequestMethod

      public ReverseTunnel.Builder setRequestMethod(RequestMethod value)
       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) = { ... }
      Parameters:
      value - The requestMethod to set.
      Returns:
      This builder for chaining.

    • clearRequestMethod

      public ReverseTunnel.Builder clearRequestMethod()
       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:
      This builder for chaining.

    • hasValidation

      public 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;
      Specified by:
      hasValidation in interface ReverseTunnelOrBuilder
      Returns:
      Whether the validation field is set.

    • getValidation

      public 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;
      Specified by:
      getValidation in interface ReverseTunnelOrBuilder
      Returns:
      The validation.

    • setValidation

      public ReverseTunnel.Builder setValidation(Validation value)
       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;

    • setValidation

      public ReverseTunnel.Builder setValidation(Validation.Builder builderForValue)
       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;

    • mergeValidation

      public ReverseTunnel.Builder mergeValidation(Validation value)
       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;

    • clearValidation

      public ReverseTunnel.Builder clearValidation()
       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;

    • getValidationBuilder

      public Validation.Builder getValidationBuilder()
       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;

    • getValidationOrBuilder

      public 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;
      Specified by:
      getValidationOrBuilder in interface ReverseTunnelOrBuilder

    • getRequiredClusterName

      public 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) = { ... }
      Specified by:
      getRequiredClusterName in interface ReverseTunnelOrBuilder
      Returns:
      The requiredClusterName.

    • getRequiredClusterNameBytes

      public 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) = { ... }
      Specified by:
      getRequiredClusterNameBytes in interface ReverseTunnelOrBuilder
      Returns:
      The bytes for requiredClusterName.

    • setRequiredClusterName

      public ReverseTunnel.Builder setRequiredClusterName(String value)
       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) = { ... }
      Parameters:
      value - The requiredClusterName to set.
      Returns:
      This builder for chaining.

    • clearRequiredClusterName

      public ReverseTunnel.Builder clearRequiredClusterName()
       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:
      This builder for chaining.

    • setRequiredClusterNameBytes

      public ReverseTunnel.Builder setRequiredClusterNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for requiredClusterName to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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