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

Class ReverseTunnel

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReverseTunnelOrBuilder, Serializable

public final class ReverseTunnel
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ReverseTunnel.Builder	Configuration for the reverse tunnel network filter.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AUTO_CLOSE_CONNECTIONS_FIELD_NUMBER
static final int	PING_INTERVAL_FIELD_NUMBER
static final int	REQUEST_METHOD_FIELD_NUMBER
static final int	REQUEST_PATH_FIELD_NUMBER
static final int	REQUIRED_CLUSTER_NAME_FIELD_NUMBER
static final int	VALIDATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getAutoCloseConnections()	Whether to automatically close connections after processing reverse tunnel requests
static ReverseTunnel	getDefaultInstance()
ReverseTunnel	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ReverseTunnel>	getParserForType()
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.
int	getSerializedSize()
Validation	getValidation()	Optional validation configuration for node and cluster identifiers.
ValidationOrBuilder	getValidationOrBuilder()	Optional validation configuration for node and cluster identifiers.
int	hashCode()
boolean	hasPingInterval()	Ping interval for health checks on established reverse tunnel connections.
boolean	hasValidation()	Optional validation configuration for node and cluster identifiers.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static ReverseTunnel.Builder	newBuilder()
static ReverseTunnel.Builder	newBuilder(ReverseTunnel prototype)
ReverseTunnel.Builder	newBuilderForType()
protected ReverseTunnel.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ReverseTunnel	parseDelimitedFrom(InputStream input)
static ReverseTunnel	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReverseTunnel	parseFrom(byte[] data)
static ReverseTunnel	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReverseTunnel	parseFrom(com.google.protobuf.ByteString data)
static ReverseTunnel	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReverseTunnel	parseFrom(com.google.protobuf.CodedInputStream input)
static ReverseTunnel	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReverseTunnel	parseFrom(InputStream input)
static ReverseTunnel	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReverseTunnel	parseFrom(ByteBuffer data)
static ReverseTunnel	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ReverseTunnel>	parser()
ReverseTunnel.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

PING_INTERVAL_FIELD_NUMBER

public static final int PING_INTERVAL_FIELD_NUMBER

See Also:

• Constant Field Values

AUTO_CLOSE_CONNECTIONS_FIELD_NUMBER

public static final int AUTO_CLOSE_CONNECTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

REQUEST_PATH_FIELD_NUMBER

public static final int REQUEST_PATH_FIELD_NUMBER

See Also:

• Constant Field Values

REQUEST_METHOD_FIELD_NUMBER

public static final int REQUEST_METHOD_FIELD_NUMBER

See Also:

• Constant Field Values

VALIDATION_FIELD_NUMBER

public static final int VALIDATION_FIELD_NUMBER

See Also:

• Constant Field Values

REQUIRED_CLUSTER_NAME_FIELD_NUMBER

public static final int REQUIRED_CLUSTER_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

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

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.

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.

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.

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.

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.

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.

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.

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 ReverseTunnel parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReverseTunnel parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReverseTunnel parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReverseTunnel parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ReverseTunnel parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ReverseTunnel parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ReverseTunnel.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReverseTunnel.Builder newBuilder()

newBuilder

public static ReverseTunnel.Builder newBuilder(ReverseTunnel prototype)

toBuilder

public ReverseTunnel.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ReverseTunnel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ReverseTunnel getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ReverseTunnel> 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 ReverseTunnel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder