io.envoyproxy.envoy.config.filter.network.tcp_proxy.v2

Interface TcpProxyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TcpProxy, TcpProxy.Builder

public interface TcpProxyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AccessLog	getAccessLog(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.
int	getAccessLogCount() Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.
List<AccessLog>	getAccessLogList() Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.
AccessLogOrBuilder	getAccessLogOrBuilder(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.
List<? extends AccessLogOrBuilder>	getAccessLogOrBuilderList() Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by the this tcp_proxy.
String	getCluster() The upstream cluster to connect to.
com.google.protobuf.ByteString	getClusterBytes() The upstream cluster to connect to.
TcpProxy.ClusterSpecifierCase	getClusterSpecifierCase()
TcpProxy.DeprecatedV1	getDeprecatedV1() Deprecated.
TcpProxy.DeprecatedV1OrBuilder	getDeprecatedV1OrBuilder() Deprecated.
com.google.protobuf.Duration	getDownstreamIdleTimeout() [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.
com.google.protobuf.DurationOrBuilder	getDownstreamIdleTimeoutOrBuilder() [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.
HashPolicy	getHashPolicy(int index) Optional configuration for TCP proxy hash policy.
int	getHashPolicyCount() Optional configuration for TCP proxy hash policy.
List<HashPolicy>	getHashPolicyList() Optional configuration for TCP proxy hash policy.
HashPolicyOrBuilder	getHashPolicyOrBuilder(int index) Optional configuration for TCP proxy hash policy.
List<? extends HashPolicyOrBuilder>	getHashPolicyOrBuilderList() Optional configuration for TCP proxy hash policy.
com.google.protobuf.Duration	getIdleTimeout() The idle timeout for connections managed by the TCP proxy filter.
com.google.protobuf.DurationOrBuilder	getIdleTimeoutOrBuilder() The idle timeout for connections managed by the TCP proxy filter.
com.google.protobuf.UInt32Value	getMaxConnectAttempts() The maximum number of unsuccessful connection attempts that will be made before giving up.
com.google.protobuf.UInt32ValueOrBuilder	getMaxConnectAttemptsOrBuilder() The maximum number of unsuccessful connection attempts that will be made before giving up.
Metadata	getMetadataMatch() Optional endpoint metadata match criteria.
MetadataOrBuilder	getMetadataMatchOrBuilder() Optional endpoint metadata match criteria.
String	getStatPrefix() The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.
com.google.protobuf.ByteString	getStatPrefixBytes() The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.
TcpProxy.TunnelingConfig	getTunnelingConfig() [#not-implemented-hide:] feature in progress If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP payloads over a shared HTTP/2 tunnel.
TcpProxy.TunnelingConfigOrBuilder	getTunnelingConfigOrBuilder() [#not-implemented-hide:] feature in progress If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP payloads over a shared HTTP/2 tunnel.
com.google.protobuf.Duration	getUpstreamIdleTimeout() [#not-implemented-hide:] .google.protobuf.Duration upstream_idle_timeout = 4;
com.google.protobuf.DurationOrBuilder	getUpstreamIdleTimeoutOrBuilder() [#not-implemented-hide:] .google.protobuf.Duration upstream_idle_timeout = 4;
TcpProxy.WeightedCluster	getWeightedClusters() Multiple upstream clusters can be specified for a given route.
TcpProxy.WeightedClusterOrBuilder	getWeightedClustersOrBuilder() Multiple upstream clusters can be specified for a given route.
boolean	hasDeprecatedV1() Deprecated.
boolean	hasDownstreamIdleTimeout() [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.
boolean	hasIdleTimeout() The idle timeout for connections managed by the TCP proxy filter.
boolean	hasMaxConnectAttempts() The maximum number of unsuccessful connection attempts that will be made before giving up.
boolean	hasMetadataMatch() Optional endpoint metadata match criteria.
boolean	hasTunnelingConfig() [#not-implemented-hide:] feature in progress If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP payloads over a shared HTTP/2 tunnel.
boolean	hasUpstreamIdleTimeout() [#not-implemented-hide:] .google.protobuf.Duration upstream_idle_timeout = 4;
boolean	hasWeightedClusters() Multiple upstream clusters can be specified for a given route.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getStatPrefix

String getStatPrefix()

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_tcp_proxy_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

getStatPrefixBytes

com.google.protobuf.ByteString getStatPrefixBytes()

 The prefix to use when emitting :ref:`statistics
 <config_network_filters_tcp_proxy_stats>`.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

getCluster

String getCluster()

 The upstream cluster to connect to.
 

string cluster = 2;

getClusterBytes

com.google.protobuf.ByteString getClusterBytes()

 The upstream cluster to connect to.
 

string cluster = 2;

hasWeightedClusters

boolean hasWeightedClusters()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.WeightedCluster weighted_clusters = 10;

getWeightedClusters

TcpProxy.WeightedCluster getWeightedClusters()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.WeightedCluster weighted_clusters = 10;

getWeightedClustersOrBuilder

TcpProxy.WeightedClusterOrBuilder getWeightedClustersOrBuilder()

 Multiple upstream clusters can be specified for a given route. The
 request is routed to one of the upstream clusters based on weights
 assigned to each cluster.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.WeightedCluster weighted_clusters = 10;

hasMetadataMatch

boolean hasMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 9;

getMetadataMatch

Metadata getMetadataMatch()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 9;

getMetadataMatchOrBuilder

MetadataOrBuilder getMetadataMatchOrBuilder()

 Optional endpoint metadata match criteria. Only endpoints in the upstream
 cluster with metadata matching that set in metadata_match will be
 considered. The filter name should be specified as *envoy.lb*.
 

.envoy.api.v2.core.Metadata metadata_match = 9;

hasIdleTimeout

boolean hasIdleTimeout()

 The idle timeout for connections managed by the TCP proxy filter. The idle timeout
 is defined as the period in which there are no bytes sent or received on either
 the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set
 to 0s, the timeout will be disabled.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 

.google.protobuf.Duration idle_timeout = 8;

getIdleTimeout

com.google.protobuf.Duration getIdleTimeout()

 The idle timeout for connections managed by the TCP proxy filter. The idle timeout
 is defined as the period in which there are no bytes sent or received on either
 the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set
 to 0s, the timeout will be disabled.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 

.google.protobuf.Duration idle_timeout = 8;

getIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()

 The idle timeout for connections managed by the TCP proxy filter. The idle timeout
 is defined as the period in which there are no bytes sent or received on either
 the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set
 to 0s, the timeout will be disabled.
 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
 

.google.protobuf.Duration idle_timeout = 8;

hasDownstreamIdleTimeout

boolean hasDownstreamIdleTimeout()

 [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy
 filter. The idle timeout is defined as the period in which there is no
 active traffic. If not set, there is no idle timeout. When the idle timeout
 is reached the connection will be closed. The distinction between
 downstream_idle_timeout/upstream_idle_timeout provides a means to set
 timeout based on the last byte sent on the downstream/upstream connection.
 

.google.protobuf.Duration downstream_idle_timeout = 3;

getDownstreamIdleTimeout

com.google.protobuf.Duration getDownstreamIdleTimeout()

 [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy
 filter. The idle timeout is defined as the period in which there is no
 active traffic. If not set, there is no idle timeout. When the idle timeout
 is reached the connection will be closed. The distinction between
 downstream_idle_timeout/upstream_idle_timeout provides a means to set
 timeout based on the last byte sent on the downstream/upstream connection.
 

.google.protobuf.Duration downstream_idle_timeout = 3;

getDownstreamIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getDownstreamIdleTimeoutOrBuilder()

 [#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy
 filter. The idle timeout is defined as the period in which there is no
 active traffic. If not set, there is no idle timeout. When the idle timeout
 is reached the connection will be closed. The distinction between
 downstream_idle_timeout/upstream_idle_timeout provides a means to set
 timeout based on the last byte sent on the downstream/upstream connection.
 

.google.protobuf.Duration downstream_idle_timeout = 3;

hasUpstreamIdleTimeout

boolean hasUpstreamIdleTimeout()

 [#not-implemented-hide:]
 

.google.protobuf.Duration upstream_idle_timeout = 4;

getUpstreamIdleTimeout

com.google.protobuf.Duration getUpstreamIdleTimeout()

 [#not-implemented-hide:]
 

.google.protobuf.Duration upstream_idle_timeout = 4;

getUpstreamIdleTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getUpstreamIdleTimeoutOrBuilder()

 [#not-implemented-hide:]
 

.google.protobuf.Duration upstream_idle_timeout = 4;

getAccessLogList

List<AccessLog> getAccessLogList()

 Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
 

repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 5;

getAccessLog

AccessLog getAccessLog(int index)

 Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
 

repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 5;

getAccessLogCount

int getAccessLogCount()

 Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
 

repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 5;

getAccessLogOrBuilderList

List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()

 Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
 

repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 5;

getAccessLogOrBuilder

AccessLogOrBuilder getAccessLogOrBuilder(int index)

 Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
 

repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 5;

hasDeprecatedV1

@Deprecated
boolean hasDeprecatedV1()

Deprecated.

 [#not-implemented-hide:] Deprecated.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.DeprecatedV1 deprecated_v1 = 6 [deprecated = true];

getDeprecatedV1

@Deprecated
TcpProxy.DeprecatedV1 getDeprecatedV1()

Deprecated.

 [#not-implemented-hide:] Deprecated.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.DeprecatedV1 deprecated_v1 = 6 [deprecated = true];

getDeprecatedV1OrBuilder

@Deprecated
TcpProxy.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()

Deprecated.

 [#not-implemented-hide:] Deprecated.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.DeprecatedV1 deprecated_v1 = 6 [deprecated = true];

hasMaxConnectAttempts

boolean hasMaxConnectAttempts()

 The maximum number of unsuccessful connection attempts that will be made before
 giving up. If the parameter is not specified, 1 connection attempt will be made.
 

.google.protobuf.UInt32Value max_connect_attempts = 7 [(.validate.rules) = { ... }

getMaxConnectAttempts

com.google.protobuf.UInt32Value getMaxConnectAttempts()

 The maximum number of unsuccessful connection attempts that will be made before
 giving up. If the parameter is not specified, 1 connection attempt will be made.
 

.google.protobuf.UInt32Value max_connect_attempts = 7 [(.validate.rules) = { ... }

getMaxConnectAttemptsOrBuilder

com.google.protobuf.UInt32ValueOrBuilder getMaxConnectAttemptsOrBuilder()

 The maximum number of unsuccessful connection attempts that will be made before
 giving up. If the parameter is not specified, 1 connection attempt will be made.
 

.google.protobuf.UInt32Value max_connect_attempts = 7 [(.validate.rules) = { ... }

getHashPolicyList

List<HashPolicy> getHashPolicyList()

 Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
 

repeated .envoy.type.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

getHashPolicy

HashPolicy getHashPolicy(int index)

 Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
 

repeated .envoy.type.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

getHashPolicyCount

int getHashPolicyCount()

 Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
 

repeated .envoy.type.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

getHashPolicyOrBuilderList

List<? extends HashPolicyOrBuilder> getHashPolicyOrBuilderList()

 Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
 

repeated .envoy.type.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

getHashPolicyOrBuilder

HashPolicyOrBuilder getHashPolicyOrBuilder(int index)

 Optional configuration for TCP proxy hash policy. If hash_policy is not set, the hash-based
 load balancing algorithms will select a host randomly. Currently the number of hash policies is
 limited to 1.
 

repeated .envoy.type.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

hasTunnelingConfig

boolean hasTunnelingConfig()

 [#not-implemented-hide:] feature in progress
 If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP
 payloads over a shared HTTP/2 tunnel. If this message is absent, the payload
 will be proxied upstream as per usual.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.TunnelingConfig tunneling_config = 12;

getTunnelingConfig

TcpProxy.TunnelingConfig getTunnelingConfig()

 [#not-implemented-hide:] feature in progress
 If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP
 payloads over a shared HTTP/2 tunnel. If this message is absent, the payload
 will be proxied upstream as per usual.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.TunnelingConfig tunneling_config = 12;

getTunnelingConfigOrBuilder

TcpProxy.TunnelingConfigOrBuilder getTunnelingConfigOrBuilder()

 [#not-implemented-hide:] feature in progress
 If set, this configures tunneling, e.g. configuration options to tunnel multiple TCP
 payloads over a shared HTTP/2 tunnel. If this message is absent, the payload
 will be proxied upstream as per usual.
 

.envoy.config.filter.network.tcp_proxy.v2.TcpProxy.TunnelingConfig tunneling_config = 12;

getClusterSpecifierCase

TcpProxy.ClusterSpecifierCase getClusterSpecifierCase()