Package io.envoyproxy.envoy.config.listener.v3

Interface FilterChainOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FilterChain, FilterChain.Builder
    public interface FilterChainOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasFilterChainMatch

        boolean hasFilterChainMatch()
         The criteria to use when matching a connection to this filter chain.
        .envoy.config.listener.v3.FilterChainMatch filter_chain_match = 1;
        Returns:
        Whether the filterChainMatch field is set.

      • getFilterChainMatch

        FilterChainMatch getFilterChainMatch()
         The criteria to use when matching a connection to this filter chain.
        .envoy.config.listener.v3.FilterChainMatch filter_chain_match = 1;
        Returns:
        The filterChainMatch.

      • getFilterChainMatchOrBuilder

        FilterChainMatchOrBuilder getFilterChainMatchOrBuilder()
         The criteria to use when matching a connection to this filter chain.
        .envoy.config.listener.v3.FilterChainMatch filter_chain_match = 1;

      • getFiltersList

        List<Filter> getFiltersList()
         A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
        repeated .envoy.config.listener.v3.Filter filters = 3;

      • getFilters

        Filter getFilters​(int index)
         A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
        repeated .envoy.config.listener.v3.Filter filters = 3;

      • getFiltersCount

        int getFiltersCount()
         A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
        repeated .envoy.config.listener.v3.Filter filters = 3;

      • getFiltersOrBuilderList

        List<? extends FilterOrBuilder> getFiltersOrBuilderList()
         A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
        repeated .envoy.config.listener.v3.Filter filters = 3;

      • getFiltersOrBuilder

        FilterOrBuilder getFiltersOrBuilder​(int index)
         A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
        repeated .envoy.config.listener.v3.Filter filters = 3;

      • hasUseProxyProto

        @Deprecated
boolean hasUseProxyProto()
        Deprecated.
        envoy.config.listener.v3.FilterChain.use_proxy_proto is deprecated. See envoy/config/listener/v3/listener_components.proto;l=241
         Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 This field is deprecated. Add a
 :ref:`PROXY protocol listener filter <config_listener_filters_proxy_protocol>`
 explicitly instead.
        .google.protobuf.BoolValue use_proxy_proto = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        Whether the useProxyProto field is set.

      • getUseProxyProto

        @Deprecated
com.google.protobuf.BoolValue getUseProxyProto()
        Deprecated.
        envoy.config.listener.v3.FilterChain.use_proxy_proto is deprecated. See envoy/config/listener/v3/listener_components.proto;l=241
         Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 This field is deprecated. Add a
 :ref:`PROXY protocol listener filter <config_listener_filters_proxy_protocol>`
 explicitly instead.
        .google.protobuf.BoolValue use_proxy_proto = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
        Returns:
        The useProxyProto.

      • getUseProxyProtoOrBuilder

        @Deprecated
com.google.protobuf.BoolValueOrBuilder getUseProxyProtoOrBuilder()
        Deprecated.
         Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 This field is deprecated. Add a
 :ref:`PROXY protocol listener filter <config_listener_filters_proxy_protocol>`
 explicitly instead.
        .google.protobuf.BoolValue use_proxy_proto = 4 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];

      • hasMetadata

        boolean hasMetadata()
         [#not-implemented-hide:] filter chain metadata.
        .envoy.config.core.v3.Metadata metadata = 5;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        Metadata getMetadata()
         [#not-implemented-hide:] filter chain metadata.
        .envoy.config.core.v3.Metadata metadata = 5;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        MetadataOrBuilder getMetadataOrBuilder()
         [#not-implemented-hide:] filter chain metadata.
        .envoy.config.core.v3.Metadata metadata = 5;

      • hasTransportSocket

        boolean hasTransportSocket()
         Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name ``envoy.transport_sockets.tls`` and
 :ref:`DownstreamTlsContext <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.DownstreamTlsContext>` in the ``typed_config``.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 [#extension-category: envoy.transport_sockets.downstream]
        .envoy.config.core.v3.TransportSocket transport_socket = 6;
        Returns:
        Whether the transportSocket field is set.

      • getTransportSocket

        TransportSocket getTransportSocket()
         Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name ``envoy.transport_sockets.tls`` and
 :ref:`DownstreamTlsContext <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.DownstreamTlsContext>` in the ``typed_config``.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 [#extension-category: envoy.transport_sockets.downstream]
        .envoy.config.core.v3.TransportSocket transport_socket = 6;
        Returns:
        The transportSocket.

      • getTransportSocketOrBuilder

        TransportSocketOrBuilder getTransportSocketOrBuilder()
         Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name ``envoy.transport_sockets.tls`` and
 :ref:`DownstreamTlsContext <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.DownstreamTlsContext>` in the ``typed_config``.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 [#extension-category: envoy.transport_sockets.downstream]
        .envoy.config.core.v3.TransportSocket transport_socket = 6;

      • hasTransportSocketConnectTimeout

        boolean hasTransportSocketConnectTimeout()
         If present and nonzero, the amount of time to allow incoming connections to complete any
 transport socket negotiations. If this expires before the transport reports connection
 establishment, the connection is summarily closed.
        .google.protobuf.Duration transport_socket_connect_timeout = 9;
        Returns:
        Whether the transportSocketConnectTimeout field is set.

      • getTransportSocketConnectTimeout

        com.google.protobuf.Duration getTransportSocketConnectTimeout()
         If present and nonzero, the amount of time to allow incoming connections to complete any
 transport socket negotiations. If this expires before the transport reports connection
 establishment, the connection is summarily closed.
        .google.protobuf.Duration transport_socket_connect_timeout = 9;
        Returns:
        The transportSocketConnectTimeout.

      • getTransportSocketConnectTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getTransportSocketConnectTimeoutOrBuilder()
         If present and nonzero, the amount of time to allow incoming connections to complete any
 transport socket negotiations. If this expires before the transport reports connection
 establishment, the connection is summarily closed.
        .google.protobuf.Duration transport_socket_connect_timeout = 9;

      • getName

        String getName()
         The unique name (or empty) by which this filter chain is known.
 Note: :ref:`filter_chain_matcher
 <envoy_v3_api_field_config.listener.v3.Listener.filter_chain_matcher>`
 requires that filter chains are uniquely named within a listener.
        string name = 7;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The unique name (or empty) by which this filter chain is known.
 Note: :ref:`filter_chain_matcher
 <envoy_v3_api_field_config.listener.v3.Listener.filter_chain_matcher>`
 requires that filter chains are uniquely named within a listener.
        string name = 7;
        Returns:
        The bytes for name.

      • hasOnDemandConfiguration

        boolean hasOnDemandConfiguration()
         [#not-implemented-hide:] The configuration to specify whether the filter chain will be built on-demand.
 If this field is not empty, the filter chain will be built on-demand.
 Otherwise, the filter chain will be built normally and block listener warming.
        .envoy.config.listener.v3.FilterChain.OnDemandConfiguration on_demand_configuration = 8;
        Returns:
        Whether the onDemandConfiguration field is set.

      • getOnDemandConfiguration

        FilterChain.OnDemandConfiguration getOnDemandConfiguration()
         [#not-implemented-hide:] The configuration to specify whether the filter chain will be built on-demand.
 If this field is not empty, the filter chain will be built on-demand.
 Otherwise, the filter chain will be built normally and block listener warming.
        .envoy.config.listener.v3.FilterChain.OnDemandConfiguration on_demand_configuration = 8;
        Returns:
        The onDemandConfiguration.

      • getOnDemandConfigurationOrBuilder

        FilterChain.OnDemandConfigurationOrBuilder getOnDemandConfigurationOrBuilder()
         [#not-implemented-hide:] The configuration to specify whether the filter chain will be built on-demand.
 If this field is not empty, the filter chain will be built on-demand.
 Otherwise, the filter chain will be built normally and block listener warming.
        .envoy.config.listener.v3.FilterChain.OnDemandConfiguration on_demand_configuration = 8;