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

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 Detail

      • 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 for a given route. The
 request is routed to one of the upstream clusters based on 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 for a given route. The
 request is routed to one of the upstream clusters based on 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 for a given route. The
 request is routed to one of the upstream clusters based on 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. 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.config.core.v3.Metadata metadata_match = 9;
        Returns:
        Whether the metadataMatch field is set.

      • 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.config.core.v3.Metadata metadata_match = 9;
        Returns:
        The metadataMatch.

      • 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.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 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;
        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 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;
        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 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;
        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

        List<AccessLog> getAccessLogList()
         Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by the this tcp_proxy.
        repeated .envoy.config.accesslog.v3.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.accesslog.v3.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.accesslog.v3.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.accesslog.v3.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.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) = { ... }

      • 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

        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.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

        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.v3.HashPolicy hash_policy = 11 [(.validate.rules) = { ... }

      • hasTunnelingConfig

        boolean hasTunnelingConfig()
         If set, this configures tunneling, e.g. configuration options to tunnel TCP payload over
 HTTP CONNECT. If this message is absent, the payload will be proxied upstream as per usual.
        .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, e.g. configuration options to tunnel TCP payload over
 HTTP CONNECT. If this message is absent, the payload will be proxied upstream as per usual.
        .envoy.extensions.filters.network.tcp_proxy.v3.TcpProxy.TunnelingConfig tunneling_config = 12;
        Returns:
        The tunnelingConfig.

      • getTunnelingConfigOrBuilder

        TcpProxy.TunnelingConfigOrBuilder getTunnelingConfigOrBuilder()
         If set, this configures tunneling, e.g. configuration options to tunnel TCP payload over
 HTTP CONNECT. If this message is absent, the payload will be proxied upstream as per usual.
        .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 max duration. When max_downstream_connection_duration
 is reached the connection will be closed. 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 max duration. When max_downstream_connection_duration
 is reached the connection will be closed. 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 max duration. When max_downstream_connection_duration
 is reached the connection will be closed. Duration must be at least 1ms.
        .google.protobuf.Duration max_downstream_connection_duration = 13 [(.validate.rules) = { ... }