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 TypeMethodDescriptiongetAccessLog(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.intConfiguration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.com.google.protobuf.DurationDeprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.access_log_flush_interval is deprecated.com.google.protobuf.DurationOrBuilderDeprecated.Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.Additional access log options for the TCP proxy.Additional access log options for the TCP proxy.getAccessLogOrBuilder(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.List<? extends AccessLogOrBuilder>Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.Sets the backoff strategy.Sets the backoff strategy.The upstream cluster to connect to.com.google.protobuf.ByteStringThe upstream cluster to connect to.com.google.protobuf.Duration[#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.com.google.protobuf.DurationOrBuilder[#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.booleanDeprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.flush_access_log_on_connected is deprecated.getHashPolicy(int index) Optional configuration for TCP proxy hash policy.intOptional configuration for TCP proxy hash policy.Optional configuration for TCP proxy hash policy.getHashPolicyOrBuilder(int index) Optional configuration for TCP proxy hash policy.List<? extends HashPolicyOrBuilder>Optional configuration for TCP proxy hash policy.com.google.protobuf.DurationThe idle timeout for connections managed by the TCP proxy filter.com.google.protobuf.DurationOrBuilderThe idle timeout for connections managed by the TCP proxy filter.com.google.protobuf.UInt32ValueThe maximum number of unsuccessful connection attempts that will be made before giving up.com.google.protobuf.UInt32ValueOrBuilderThe maximum number of unsuccessful connection attempts that will be made before giving up.com.google.protobuf.DurationThe maximum duration of a connection.Percentage-based jitter for ``max_downstream_connection_duration``.Percentage-based jitter for ``max_downstream_connection_duration``.com.google.protobuf.DurationOrBuilderThe maximum duration of a connection.com.google.protobuf.UInt32ValueMaximum bytes of early data to buffer from the downstream connection before the upstream connection is established.com.google.protobuf.UInt32ValueOrBuilderMaximum bytes of early data to buffer from the downstream connection before the upstream connection is established.Optional endpoint metadata match criteria used by the subset load balancer.Optional endpoint metadata match criteria used by the subset load balancer.The on demand policy for the upstream cluster.The on demand policy for the upstream cluster.getProxyProtocolTlvs(int index) If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter.intIf set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter.If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter.getProxyProtocolTlvsOrBuilder(int index) If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter.List<? extends TlvEntryOrBuilder>If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter.The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.com.google.protobuf.ByteStringThe prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.If set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT.If set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT.Specifies when to establish the upstream connection.intSpecifies when to establish the upstream connection.com.google.protobuf.Duration[#not-implemented-hide:]com.google.protobuf.DurationOrBuilder[#not-implemented-hide:]Multiple upstream clusters can be specified.Multiple upstream clusters can be specified.booleanDeprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.access_log_flush_interval is deprecated.booleanAdditional access log options for the TCP proxy.booleanSets the backoff strategy.booleanThe upstream cluster to connect to.boolean[#not-implemented-hide:] The idle timeout for connections managed by the TCP proxy filter.booleanThe idle timeout for connections managed by the TCP proxy filter.booleanThe maximum number of unsuccessful connection attempts that will be made before giving up.booleanThe maximum duration of a connection.booleanPercentage-based jitter for ``max_downstream_connection_duration``.booleanMaximum bytes of early data to buffer from the downstream connection before the upstream connection is established.booleanOptional endpoint metadata match criteria used by the subset load balancer.booleanThe on demand policy for the upstream cluster.booleanIf set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT.boolean[#not-implemented-hide:]booleanMultiple upstream clusters can be specified.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getStatPrefix
String getStatPrefix()The prefix to use when emitting :ref:`statistics <config_network_filters_tcp_proxy_stats>`.
string stat_prefix = 1 [(.validate.rules) = { ... }- Returns:
- The statPrefix.
-
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) = { ... }- Returns:
- The bytes for statPrefix.
-
hasCluster
boolean hasCluster()The upstream cluster to connect to.
string cluster = 2;- Returns:
- Whether the cluster field is set.
-
getCluster
String getCluster()The upstream cluster to connect to.
string cluster = 2;- Returns:
- The cluster.
-
getClusterBytes
com.google.protobuf.ByteString getClusterBytes()The upstream cluster to connect to.
string cluster = 2;- Returns:
- The bytes for cluster.
-
hasWeightedClusters
boolean hasWeightedClusters()Multiple upstream clusters can be specified. The request is routed to one of the upstream clusters based on the weights assigned to each cluster.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.WeightedCluster weighted_clusters = 10;- Returns:
- Whether the weightedClusters field is set.
-
getWeightedClusters
TcpProxy.WeightedCluster getWeightedClusters()Multiple upstream clusters can be specified. The request is routed to one of the upstream clusters based on the weights assigned to each cluster.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.WeightedCluster weighted_clusters = 10;- Returns:
- The weightedClusters.
-
getWeightedClustersOrBuilder
TcpProxy.WeightedClusterOrBuilder getWeightedClustersOrBuilder()Multiple upstream clusters can be specified. The request is routed to one of the upstream clusters based on the weights assigned to each cluster.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.WeightedCluster weighted_clusters = 10; -
hasOnDemand
boolean hasOnDemand()The on demand policy for the upstream cluster. It applies to both :ref:`TcpProxy.cluster <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.cluster>` and :ref:`TcpProxy.weighted_clusters <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.weighted_clusters>`.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.OnDemand on_demand = 14;- Returns:
- Whether the onDemand field is set.
-
getOnDemand
TcpProxy.OnDemand getOnDemand()The on demand policy for the upstream cluster. It applies to both :ref:`TcpProxy.cluster <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.cluster>` and :ref:`TcpProxy.weighted_clusters <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.weighted_clusters>`.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.OnDemand on_demand = 14;- Returns:
- The onDemand.
-
getOnDemandOrBuilder
TcpProxy.OnDemandOrBuilder getOnDemandOrBuilder()The on demand policy for the upstream cluster. It applies to both :ref:`TcpProxy.cluster <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.cluster>` and :ref:`TcpProxy.weighted_clusters <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.weighted_clusters>`.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.OnDemand on_demand = 14; -
hasMetadataMatch
boolean hasMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered for load balancing. The filter name should be specified as ``envoy.lb``.
.envoy.config.core.v3.Metadata metadata_match = 9;- Returns:
- Whether the metadataMatch field is set.
-
getMetadataMatch
Metadata getMetadataMatch()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered for load balancing. The filter name should be specified as ``envoy.lb``.
.envoy.config.core.v3.Metadata metadata_match = 9;- Returns:
- The metadataMatch.
-
getMetadataMatchOrBuilder
MetadataOrBuilder getMetadataMatchOrBuilder()Optional endpoint metadata match criteria used by the subset load balancer. Only endpoints in the upstream cluster with metadata matching what is set in this field will be considered for load balancing. The filter name should be specified as ``envoy.lb``.
.envoy.config.core.v3.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 is disabled. It is possible to dynamically override this configuration by setting a per-connection filter state object for the key ``envoy.tcp_proxy.per_connection_idle_timeout_ms``. .. warning:: Disabling this timeout is likely to yield connection leaks due to lost TCP FIN packets, etc.
.google.protobuf.Duration idle_timeout = 8;- Returns:
- Whether the idleTimeout field is set.
-
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 is disabled. It is possible to dynamically override this configuration by setting a per-connection filter state object for the key ``envoy.tcp_proxy.per_connection_idle_timeout_ms``. .. warning:: Disabling this timeout is likely to yield connection leaks due to lost TCP FIN packets, etc.
.google.protobuf.Duration idle_timeout = 8;- Returns:
- The idleTimeout.
-
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 is disabled. It is possible to dynamically override this configuration by setting a per-connection filter state object for the key ``envoy.tcp_proxy.per_connection_idle_timeout_ms``. .. warning:: Disabling this timeout is likely to yield 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;- Returns:
- Whether the downstreamIdleTimeout field is set.
-
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;- Returns:
- The downstreamIdleTimeout.
-
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;- Returns:
- Whether the upstreamIdleTimeout field is set.
-
getUpstreamIdleTimeout
com.google.protobuf.Duration getUpstreamIdleTimeout()[#not-implemented-hide:]
.google.protobuf.Duration upstream_idle_timeout = 4;- Returns:
- The upstreamIdleTimeout.
-
getUpstreamIdleTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getUpstreamIdleTimeoutOrBuilder()[#not-implemented-hide:]
.google.protobuf.Duration upstream_idle_timeout = 4; -
getAccessLogList
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5; -
getAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5; -
getAccessLogCount
int getAccessLogCount()Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5; -
getAccessLogOrBuilderList
List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5; -
getAccessLogOrBuilder
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this TCP proxy.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 5; -
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) = { ... }- Returns:
- Whether the maxConnectAttempts field is set.
-
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) = { ... }- Returns:
- The maxConnectAttempts.
-
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) = { ... } -
hasBackoffOptions
boolean hasBackoffOptions()Sets the backoff strategy. If not set, the retries are performed without backoff.
.envoy.config.core.v3.BackoffStrategy backoff_options = 18;- Returns:
- Whether the backoffOptions field is set.
-
getBackoffOptions
BackoffStrategy getBackoffOptions()Sets the backoff strategy. If not set, the retries are performed without backoff.
.envoy.config.core.v3.BackoffStrategy backoff_options = 18;- Returns:
- The backoffOptions.
-
getBackoffOptionsOrBuilder
BackoffStrategyOrBuilder getBackoffOptionsOrBuilder()Sets the backoff strategy. If not set, the retries are performed without backoff.
.envoy.config.core.v3.BackoffStrategy backoff_options = 18; -
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.v3.HashPolicy hash_policy = 11 [(.validate.rules) = { ... } -
getHashPolicy
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.v3.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.v3.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.v3.HashPolicy hash_policy = 11 [(.validate.rules) = { ... } -
getHashPolicyOrBuilder
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.v3.HashPolicy hash_policy = 11 [(.validate.rules) = { ... } -
hasTunnelingConfig
boolean hasTunnelingConfig()If set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT. If this message is absent, the payload is proxied upstream as usual. It is possible to dynamically override this configuration and disable tunneling per connection by setting a per-connection filter state object for the key ``envoy.tcp_proxy.disable_tunneling``.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig tunneling_config = 12;- Returns:
- Whether the tunnelingConfig field is set.
-
getTunnelingConfig
TcpProxy.TunnelingConfig getTunnelingConfig()If set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT. If this message is absent, the payload is proxied upstream as usual. It is possible to dynamically override this configuration and disable tunneling per connection by setting a per-connection filter state object for the key ``envoy.tcp_proxy.disable_tunneling``.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig tunneling_config = 12;- Returns:
- The tunnelingConfig.
-
getTunnelingConfigOrBuilder
TcpProxy.TunnelingConfigOrBuilder getTunnelingConfigOrBuilder()If set, this configures tunneling, for example configuration options to tunnel TCP payload over HTTP CONNECT. If this message is absent, the payload is proxied upstream as usual. It is possible to dynamically override this configuration and disable tunneling per connection by setting a per-connection filter state object for the key ``envoy.tcp_proxy.disable_tunneling``.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig tunneling_config = 12; -
hasMaxDownstreamConnectionDuration
boolean hasMaxDownstreamConnectionDuration()The maximum duration of a connection. The duration is defined as the period since a connection was established. If not set, there is no maximum duration. When ``max_downstream_connection_duration`` is reached, the connection is closed. The duration must be at least ``1ms``.
.google.protobuf.Duration max_downstream_connection_duration = 13 [(.validate.rules) = { ... }- Returns:
- Whether the maxDownstreamConnectionDuration field is set.
-
getMaxDownstreamConnectionDuration
com.google.protobuf.Duration getMaxDownstreamConnectionDuration()The maximum duration of a connection. The duration is defined as the period since a connection was established. If not set, there is no maximum duration. When ``max_downstream_connection_duration`` is reached, the connection is closed. The duration must be at least ``1ms``.
.google.protobuf.Duration max_downstream_connection_duration = 13 [(.validate.rules) = { ... }- Returns:
- The maxDownstreamConnectionDuration.
-
getMaxDownstreamConnectionDurationOrBuilder
com.google.protobuf.DurationOrBuilder getMaxDownstreamConnectionDurationOrBuilder()The maximum duration of a connection. The duration is defined as the period since a connection was established. If not set, there is no maximum duration. When ``max_downstream_connection_duration`` is reached, the connection is closed. The duration must be at least ``1ms``.
.google.protobuf.Duration max_downstream_connection_duration = 13 [(.validate.rules) = { ... } -
hasMaxDownstreamConnectionDurationJitterPercentage
boolean hasMaxDownstreamConnectionDurationJitterPercentage()Percentage-based jitter for ``max_downstream_connection_duration``. The jitter increases the ``max_downstream_connection_duration`` by a random duration up to the provided percentage. This field is ignored if ``max_downstream_connection_duration`` is not set. If not set, no jitter is added.
.envoy.type.v3.Percent max_downstream_connection_duration_jitter_percentage = 20;- Returns:
- Whether the maxDownstreamConnectionDurationJitterPercentage field is set.
-
getMaxDownstreamConnectionDurationJitterPercentage
Percent getMaxDownstreamConnectionDurationJitterPercentage()Percentage-based jitter for ``max_downstream_connection_duration``. The jitter increases the ``max_downstream_connection_duration`` by a random duration up to the provided percentage. This field is ignored if ``max_downstream_connection_duration`` is not set. If not set, no jitter is added.
.envoy.type.v3.Percent max_downstream_connection_duration_jitter_percentage = 20;- Returns:
- The maxDownstreamConnectionDurationJitterPercentage.
-
getMaxDownstreamConnectionDurationJitterPercentageOrBuilder
PercentOrBuilder getMaxDownstreamConnectionDurationJitterPercentageOrBuilder()Percentage-based jitter for ``max_downstream_connection_duration``. The jitter increases the ``max_downstream_connection_duration`` by a random duration up to the provided percentage. This field is ignored if ``max_downstream_connection_duration`` is not set. If not set, no jitter is added.
.envoy.type.v3.Percent max_downstream_connection_duration_jitter_percentage = 20; -
hasAccessLogFlushInterval
Deprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.access_log_flush_interval is deprecated. See envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto;l=304If both this field and :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`.
.google.protobuf.Duration access_log_flush_interval = 15 [deprecated = true, (.validate.rules) = { ... }- Returns:
- Whether the accessLogFlushInterval field is set.
-
getAccessLogFlushInterval
Deprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.access_log_flush_interval is deprecated. See envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto;l=304If both this field and :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`.
.google.protobuf.Duration access_log_flush_interval = 15 [deprecated = true, (.validate.rules) = { ... }- Returns:
- The accessLogFlushInterval.
-
getAccessLogFlushIntervalOrBuilder
Deprecated.If both this field and :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`access_log_flush_interval <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.access_log_flush_interval>`.
.google.protobuf.Duration access_log_flush_interval = 15 [deprecated = true, (.validate.rules) = { ... } -
getFlushAccessLogOnConnected
Deprecated.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.flush_access_log_on_connected is deprecated. See envoy/extensions/filters/network/tcp_proxy/v3/tcp_proxy.proto;l=318If both this field and :ref:`flush_access_log_on_connected <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>` are specified, the former (deprecated field) is ignored. .. attention:: This field is deprecated in favor of :ref:`flush_access_log_on_connected <envoy_v3_api_field_extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions.flush_access_log_on_connected>`.
bool flush_access_log_on_connected = 16 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Returns:
- The flushAccessLogOnConnected.
-
hasAccessLogOptions
boolean hasAccessLogOptions()Additional access log options for the TCP proxy.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions access_log_options = 17;- Returns:
- Whether the accessLogOptions field is set.
-
getAccessLogOptions
TcpProxy.TcpAccessLogOptions getAccessLogOptions()Additional access log options for the TCP proxy.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions access_log_options = 17;- Returns:
- The accessLogOptions.
-
getAccessLogOptionsOrBuilder
TcpProxy.TcpAccessLogOptionsOrBuilder getAccessLogOptionsOrBuilder()Additional access log options for the TCP proxy.
.envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TcpAccessLogOptions access_log_options = 17; -
getProxyProtocolTlvsList
If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter. These TLVs are sent in the PROXY protocol v2 header to the upstream. This field only takes effect when the TCP proxy filter is creating new ``PROXY`` protocol state and an upstream proxy protocol transport socket is configured in the cluster. If the connection already contains ``PROXY`` protocol state (including any TLVs) parsed by a downstream proxy protocol listener upstream proxy protocol transport socket is configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure the specified TLVs are allowed in the upstream ``PROXY`` protocol header, you must also configure passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.
repeated .envoy.config.core.v3.TlvEntry proxy_protocol_tlvs = 19; -
getProxyProtocolTlvs
If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter. These TLVs are sent in the PROXY protocol v2 header to the upstream. This field only takes effect when the TCP proxy filter is creating new ``PROXY`` protocol state and an upstream proxy protocol transport socket is configured in the cluster. If the connection already contains ``PROXY`` protocol state (including any TLVs) parsed by a downstream proxy protocol listener upstream proxy protocol transport socket is configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure the specified TLVs are allowed in the upstream ``PROXY`` protocol header, you must also configure passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.
repeated .envoy.config.core.v3.TlvEntry proxy_protocol_tlvs = 19; -
getProxyProtocolTlvsCount
int getProxyProtocolTlvsCount()If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter. These TLVs are sent in the PROXY protocol v2 header to the upstream. This field only takes effect when the TCP proxy filter is creating new ``PROXY`` protocol state and an upstream proxy protocol transport socket is configured in the cluster. If the connection already contains ``PROXY`` protocol state (including any TLVs) parsed by a downstream proxy protocol listener upstream proxy protocol transport socket is configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure the specified TLVs are allowed in the upstream ``PROXY`` protocol header, you must also configure passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.
repeated .envoy.config.core.v3.TlvEntry proxy_protocol_tlvs = 19; -
getProxyProtocolTlvsOrBuilderList
List<? extends TlvEntryOrBuilder> getProxyProtocolTlvsOrBuilderList()If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter. These TLVs are sent in the PROXY protocol v2 header to the upstream. This field only takes effect when the TCP proxy filter is creating new ``PROXY`` protocol state and an upstream proxy protocol transport socket is configured in the cluster. If the connection already contains ``PROXY`` protocol state (including any TLVs) parsed by a downstream proxy protocol listener upstream proxy protocol transport socket is configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure the specified TLVs are allowed in the upstream ``PROXY`` protocol header, you must also configure passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.
repeated .envoy.config.core.v3.TlvEntry proxy_protocol_tlvs = 19; -
getProxyProtocolTlvsOrBuilder
If set, the specified ``PROXY`` protocol TLVs (Type-Length-Value) are added to the ``PROXY`` protocol state created by the TCP proxy filter. These TLVs are sent in the PROXY protocol v2 header to the upstream. This field only takes effect when the TCP proxy filter is creating new ``PROXY`` protocol state and an upstream proxy protocol transport socket is configured in the cluster. If the connection already contains ``PROXY`` protocol state (including any TLVs) parsed by a downstream proxy protocol listener upstream proxy protocol transport socket is configured in the cluster. If the connection already contains PROXY protocol state (including any TLVs) parsed by a downstream proxy protocol listener filter, the TLVs specified here are ignored. .. note:: To ensure the specified TLVs are allowed in the upstream ``PROXY`` protocol header, you must also configure passthrough TLVs on the upstream proxy protocol transport. See :ref:`core.v3.ProxyProtocolConfig.pass_through_tlvs <envoy_v3_api_field_config.core.v3.ProxyProtocolConfig.pass_through_tlvs>` for details.
repeated .envoy.config.core.v3.TlvEntry proxy_protocol_tlvs = 19; -
getUpstreamConnectModeValue
int getUpstreamConnectModeValue()Specifies when to establish the upstream connection. When not specified, defaults to ``IMMEDIATE`` for backward compatibility. .. attention:: Server-first protocols (e.g., SMTP, MySQL, POP3) require ``IMMEDIATE`` mode.
.envoy.extensions.filters.network.tcp_proxy.v3.UpstreamConnectMode upstream_connect_mode = 21 [(.validate.rules) = { ... }- Returns:
- The enum numeric value on the wire for upstreamConnectMode.
-
getUpstreamConnectMode
UpstreamConnectMode getUpstreamConnectMode()Specifies when to establish the upstream connection. When not specified, defaults to ``IMMEDIATE`` for backward compatibility. .. attention:: Server-first protocols (e.g., SMTP, MySQL, POP3) require ``IMMEDIATE`` mode.
.envoy.extensions.filters.network.tcp_proxy.v3.UpstreamConnectMode upstream_connect_mode = 21 [(.validate.rules) = { ... }- Returns:
- The upstreamConnectMode.
-
hasMaxEarlyDataBytes
boolean hasMaxEarlyDataBytes()Maximum bytes of early data to buffer from the downstream connection before the upstream connection is established. If not set, the TCP proxy will read-disable the downstream connection until the upstream connection is established (legacy behavior). If set, enables ``receive_before_connect`` mode where the filter allows the filter chain to read downstream data before the upstream connection exists. The data is buffered and forwarded once the upstream connection is ready. When the buffer exceeds this limit, the downstream connection is read-disabled to prevent excessive memory usage. This field is required when ``upstream_connect_mode`` is ``ON_DOWNSTREAM_DATA``. .. note:: Use this carefully with server-first protocols. The upstream may send data before receiving anything from downstream, which could fill the early data buffer.
.google.protobuf.UInt32Value max_early_data_bytes = 22 [(.validate.rules) = { ... }- Returns:
- Whether the maxEarlyDataBytes field is set.
-
getMaxEarlyDataBytes
com.google.protobuf.UInt32Value getMaxEarlyDataBytes()Maximum bytes of early data to buffer from the downstream connection before the upstream connection is established. If not set, the TCP proxy will read-disable the downstream connection until the upstream connection is established (legacy behavior). If set, enables ``receive_before_connect`` mode where the filter allows the filter chain to read downstream data before the upstream connection exists. The data is buffered and forwarded once the upstream connection is ready. When the buffer exceeds this limit, the downstream connection is read-disabled to prevent excessive memory usage. This field is required when ``upstream_connect_mode`` is ``ON_DOWNSTREAM_DATA``. .. note:: Use this carefully with server-first protocols. The upstream may send data before receiving anything from downstream, which could fill the early data buffer.
.google.protobuf.UInt32Value max_early_data_bytes = 22 [(.validate.rules) = { ... }- Returns:
- The maxEarlyDataBytes.
-
getMaxEarlyDataBytesOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxEarlyDataBytesOrBuilder()Maximum bytes of early data to buffer from the downstream connection before the upstream connection is established. If not set, the TCP proxy will read-disable the downstream connection until the upstream connection is established (legacy behavior). If set, enables ``receive_before_connect`` mode where the filter allows the filter chain to read downstream data before the upstream connection exists. The data is buffered and forwarded once the upstream connection is ready. When the buffer exceeds this limit, the downstream connection is read-disabled to prevent excessive memory usage. This field is required when ``upstream_connect_mode`` is ``ON_DOWNSTREAM_DATA``. .. note:: Use this carefully with server-first protocols. The upstream may send data before receiving anything from downstream, which could fill the early data buffer.
.google.protobuf.UInt32Value max_early_data_bytes = 22 [(.validate.rules) = { ... } -
getClusterSpecifierCase
TcpProxy.ClusterSpecifierCase getClusterSpecifierCase()
-