Interface ListenerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Listener, Listener.Builder

public interface ListenerOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       The unique name by which this listener is known. If no name is provided,
       Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically
       updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
       
      string name = 1;
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The unique name by which this listener is known. If no name is provided,
       Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically
       updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
       
      string name = 1;
      Returns:
      The bytes for name.
    • hasAddress

      boolean hasAddress()
       The address that the listener should listen on. In general, the address must be unique, though
       that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
       Linux as the actual port will be allocated by the OS.
       Required unless ``api_listener`` or ``listener_specifier`` is populated.
       
      .envoy.config.core.v3.Address address = 2;
      Returns:
      Whether the address field is set.
    • getAddress

      Address getAddress()
       The address that the listener should listen on. In general, the address must be unique, though
       that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
       Linux as the actual port will be allocated by the OS.
       Required unless ``api_listener`` or ``listener_specifier`` is populated.
       
      .envoy.config.core.v3.Address address = 2;
      Returns:
      The address.
    • getAddressOrBuilder

      AddressOrBuilder getAddressOrBuilder()
       The address that the listener should listen on. In general, the address must be unique, though
       that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
       Linux as the actual port will be allocated by the OS.
       Required unless ``api_listener`` or ``listener_specifier`` is populated.
       
      .envoy.config.core.v3.Address address = 2;
    • getAdditionalAddressesList

      List<AdditionalAddress> getAdditionalAddressesList()
       The additional addresses the listener should listen on. The addresses must be unique across all
       listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
       all addresses use the same protocol, and multiple internal addresses are not supported.
       
      repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
    • getAdditionalAddresses

      AdditionalAddress getAdditionalAddresses(int index)
       The additional addresses the listener should listen on. The addresses must be unique across all
       listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
       all addresses use the same protocol, and multiple internal addresses are not supported.
       
      repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
    • getAdditionalAddressesCount

      int getAdditionalAddressesCount()
       The additional addresses the listener should listen on. The addresses must be unique across all
       listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
       all addresses use the same protocol, and multiple internal addresses are not supported.
       
      repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
    • getAdditionalAddressesOrBuilderList

      List<? extends AdditionalAddressOrBuilder> getAdditionalAddressesOrBuilderList()
       The additional addresses the listener should listen on. The addresses must be unique across all
       listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
       all addresses use the same protocol, and multiple internal addresses are not supported.
       
      repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
    • getAdditionalAddressesOrBuilder

      AdditionalAddressOrBuilder getAdditionalAddressesOrBuilder(int index)
       The additional addresses the listener should listen on. The addresses must be unique across all
       listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
       all addresses use the same protocol, and multiple internal addresses are not supported.
       
      repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
    • getStatPrefix

      String getStatPrefix()
       Optional prefix to use on listener stats. If empty, the stats will be rooted at
       ``listener.<address as string>.``. If non-empty, stats will be rooted at
       ``listener.<stat_prefix>.``.
       
      string stat_prefix = 28;
      Returns:
      The statPrefix.
    • getStatPrefixBytes

      com.google.protobuf.ByteString getStatPrefixBytes()
       Optional prefix to use on listener stats. If empty, the stats will be rooted at
       ``listener.<address as string>.``. If non-empty, stats will be rooted at
       ``listener.<stat_prefix>.``.
       
      string stat_prefix = 28;
      Returns:
      The bytes for statPrefix.
    • getFilterChainsList

      List<FilterChain> getFilterChainsList()
       A list of filter chains to consider for this listener. The
       :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
       :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
       connection.
      
       Example using SNI for filter chain selection can be found in the
       :ref:`FAQ entry <faq_how_to_setup_sni>`.
       
      repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
    • getFilterChains

      FilterChain getFilterChains(int index)
       A list of filter chains to consider for this listener. The
       :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
       :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
       connection.
      
       Example using SNI for filter chain selection can be found in the
       :ref:`FAQ entry <faq_how_to_setup_sni>`.
       
      repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
    • getFilterChainsCount

      int getFilterChainsCount()
       A list of filter chains to consider for this listener. The
       :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
       :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
       connection.
      
       Example using SNI for filter chain selection can be found in the
       :ref:`FAQ entry <faq_how_to_setup_sni>`.
       
      repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
    • getFilterChainsOrBuilderList

      List<? extends FilterChainOrBuilder> getFilterChainsOrBuilderList()
       A list of filter chains to consider for this listener. The
       :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
       :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
       connection.
      
       Example using SNI for filter chain selection can be found in the
       :ref:`FAQ entry <faq_how_to_setup_sni>`.
       
      repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
    • getFilterChainsOrBuilder

      FilterChainOrBuilder getFilterChainsOrBuilder(int index)
       A list of filter chains to consider for this listener. The
       :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
       :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
       connection.
      
       Example using SNI for filter chain selection can be found in the
       :ref:`FAQ entry <faq_how_to_setup_sni>`.
       
      repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
    • hasFilterChainMatcher

      boolean hasFilterChainMatcher()
       :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
       network properties. This matcher is used as a replacement for the filter chain match condition
       :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
       non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
       and not specify :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
      
       .. note::
      
       Once matched, each connection is permanently bound to its filter chain.
       If the matcher changes but the filter chain remains the same, the
       connections bound to the filter chain are not drained. If, however, the
       filter chain is removed or structurally modified, then the drain for its
       connections is initiated.
       
      .xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
      Returns:
      Whether the filterChainMatcher field is set.
    • getFilterChainMatcher

      Matcher getFilterChainMatcher()
       :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
       network properties. This matcher is used as a replacement for the filter chain match condition
       :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
       non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
       and not specify :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
      
       .. note::
      
       Once matched, each connection is permanently bound to its filter chain.
       If the matcher changes but the filter chain remains the same, the
       connections bound to the filter chain are not drained. If, however, the
       filter chain is removed or structurally modified, then the drain for its
       connections is initiated.
       
      .xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
      Returns:
      The filterChainMatcher.
    • getFilterChainMatcherOrBuilder

      MatcherOrBuilder getFilterChainMatcherOrBuilder()
       :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
       network properties. This matcher is used as a replacement for the filter chain match condition
       :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
       non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
       and not specify :ref:`filter_chain_match
       <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
      
       .. note::
      
       Once matched, each connection is permanently bound to its filter chain.
       If the matcher changes but the filter chain remains the same, the
       connections bound to the filter chain are not drained. If, however, the
       filter chain is removed or structurally modified, then the drain for its
       connections is initiated.
       
      .xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
    • hasUseOriginalDst

      boolean hasUseOriginalDst()
       If a connection is redirected using ``iptables``, the port on which the proxy
       receives it might be different from the original destination address. When this flag is set to
       true, the listener hands off redirected connections to the listener associated with the
       original destination address. If there is no listener associated with the original destination
       address, the connection is handled by the listener that receives it. Defaults to false.
       
      .google.protobuf.BoolValue use_original_dst = 4;
      Returns:
      Whether the useOriginalDst field is set.
    • getUseOriginalDst

      com.google.protobuf.BoolValue getUseOriginalDst()
       If a connection is redirected using ``iptables``, the port on which the proxy
       receives it might be different from the original destination address. When this flag is set to
       true, the listener hands off redirected connections to the listener associated with the
       original destination address. If there is no listener associated with the original destination
       address, the connection is handled by the listener that receives it. Defaults to false.
       
      .google.protobuf.BoolValue use_original_dst = 4;
      Returns:
      The useOriginalDst.
    • getUseOriginalDstOrBuilder

      com.google.protobuf.BoolValueOrBuilder getUseOriginalDstOrBuilder()
       If a connection is redirected using ``iptables``, the port on which the proxy
       receives it might be different from the original destination address. When this flag is set to
       true, the listener hands off redirected connections to the listener associated with the
       original destination address. If there is no listener associated with the original destination
       address, the connection is handled by the listener that receives it. Defaults to false.
       
      .google.protobuf.BoolValue use_original_dst = 4;
    • hasDefaultFilterChain

      boolean hasDefaultFilterChain()
       The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
       the connection will be closed. The filter chain match is ignored in this field.
       
      .envoy.config.listener.v3.FilterChain default_filter_chain = 25;
      Returns:
      Whether the defaultFilterChain field is set.
    • getDefaultFilterChain

      FilterChain getDefaultFilterChain()
       The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
       the connection will be closed. The filter chain match is ignored in this field.
       
      .envoy.config.listener.v3.FilterChain default_filter_chain = 25;
      Returns:
      The defaultFilterChain.
    • getDefaultFilterChainOrBuilder

      FilterChainOrBuilder getDefaultFilterChainOrBuilder()
       The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
       the connection will be closed. The filter chain match is ignored in this field.
       
      .envoy.config.listener.v3.FilterChain default_filter_chain = 25;
    • hasPerConnectionBufferLimitBytes

      boolean hasPerConnectionBufferLimitBytes()
       Soft limit on size of the listener’s new connection read and write buffers.
       If unspecified, an implementation defined default is applied (1MiB).
       
      .google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }
      Returns:
      Whether the perConnectionBufferLimitBytes field is set.
    • getPerConnectionBufferLimitBytes

      com.google.protobuf.UInt32Value getPerConnectionBufferLimitBytes()
       Soft limit on size of the listener’s new connection read and write buffers.
       If unspecified, an implementation defined default is applied (1MiB).
       
      .google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }
      Returns:
      The perConnectionBufferLimitBytes.
    • getPerConnectionBufferLimitBytesOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getPerConnectionBufferLimitBytesOrBuilder()
       Soft limit on size of the listener’s new connection read and write buffers.
       If unspecified, an implementation defined default is applied (1MiB).
       
      .google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }
    • hasMetadata

      boolean hasMetadata()
       Listener metadata.
       
      .envoy.config.core.v3.Metadata metadata = 6;
      Returns:
      Whether the metadata field is set.
    • getMetadata

      Metadata getMetadata()
       Listener metadata.
       
      .envoy.config.core.v3.Metadata metadata = 6;
      Returns:
      The metadata.
    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       Listener metadata.
       
      .envoy.config.core.v3.Metadata metadata = 6;
    • hasDeprecatedV1

      @Deprecated boolean hasDeprecatedV1()
      Deprecated.
      envoy.config.listener.v3.Listener.deprecated_v1 is deprecated. See envoy/config/listener/v3/listener.proto;l=188
       [#not-implemented-hide:]
       
      .envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      Whether the deprecatedV1 field is set.
    • getDeprecatedV1

      Deprecated.
      envoy.config.listener.v3.Listener.deprecated_v1 is deprecated. See envoy/config/listener/v3/listener.proto;l=188
       [#not-implemented-hide:]
       
      .envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The deprecatedV1.
    • getDeprecatedV1OrBuilder

      @Deprecated Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
      Deprecated.
       [#not-implemented-hide:]
       
      .envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
    • getDrainTypeValue

      int getDrainTypeValue()
       The type of draining to perform at a listener-wide level.
       
      .envoy.config.listener.v3.Listener.DrainType drain_type = 8;
      Returns:
      The enum numeric value on the wire for drainType.
    • getDrainType

      Listener.DrainType getDrainType()
       The type of draining to perform at a listener-wide level.
       
      .envoy.config.listener.v3.Listener.DrainType drain_type = 8;
      Returns:
      The drainType.
    • getListenerFiltersList

      List<ListenerFilter> getListenerFiltersList()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
       is used in connection filter chain matching, for example. These filters are run before any in
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
       filters are processed sequentially right after a socket has been accepted by the listener, and
       before a connection is created.
       UDP Listener filters can be specified when the protocol in the listener socket address in
       :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
       :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       QUIC listener filters can be specified when :ref:`quic_options
       <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
       specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
       
      repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
    • getListenerFilters

      ListenerFilter getListenerFilters(int index)
       Listener filters have the opportunity to manipulate and augment the connection metadata that
       is used in connection filter chain matching, for example. These filters are run before any in
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
       filters are processed sequentially right after a socket has been accepted by the listener, and
       before a connection is created.
       UDP Listener filters can be specified when the protocol in the listener socket address in
       :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
       :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       QUIC listener filters can be specified when :ref:`quic_options
       <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
       specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
       
      repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
    • getListenerFiltersCount

      int getListenerFiltersCount()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
       is used in connection filter chain matching, for example. These filters are run before any in
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
       filters are processed sequentially right after a socket has been accepted by the listener, and
       before a connection is created.
       UDP Listener filters can be specified when the protocol in the listener socket address in
       :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
       :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       QUIC listener filters can be specified when :ref:`quic_options
       <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
       specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
       
      repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
    • getListenerFiltersOrBuilderList

      List<? extends ListenerFilterOrBuilder> getListenerFiltersOrBuilderList()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
       is used in connection filter chain matching, for example. These filters are run before any in
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
       filters are processed sequentially right after a socket has been accepted by the listener, and
       before a connection is created.
       UDP Listener filters can be specified when the protocol in the listener socket address in
       :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
       :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       QUIC listener filters can be specified when :ref:`quic_options
       <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
       specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
       
      repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
    • getListenerFiltersOrBuilder

      ListenerFilterOrBuilder getListenerFiltersOrBuilder(int index)
       Listener filters have the opportunity to manipulate and augment the connection metadata that
       is used in connection filter chain matching, for example. These filters are run before any in
       :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
       filters are processed sequentially right after a socket has been accepted by the listener, and
       before a connection is created.
       UDP Listener filters can be specified when the protocol in the listener socket address in
       :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
       :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       QUIC listener filters can be specified when :ref:`quic_options
       <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
       specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
       They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
       
      repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
    • hasListenerFiltersTimeout

      boolean hasListenerFiltersTimeout()
       The timeout to wait for all listener filters to complete operation. If the timeout is reached,
       the accepted socket is closed without a connection being created unless
       ``continue_on_listener_filters_timeout`` is set to true. Specify 0 to disable the
       timeout. If not specified, a default timeout of 15s is used.
       
      .google.protobuf.Duration listener_filters_timeout = 15;
      Returns:
      Whether the listenerFiltersTimeout field is set.
    • getListenerFiltersTimeout

      com.google.protobuf.Duration getListenerFiltersTimeout()
       The timeout to wait for all listener filters to complete operation. If the timeout is reached,
       the accepted socket is closed without a connection being created unless
       ``continue_on_listener_filters_timeout`` is set to true. Specify 0 to disable the
       timeout. If not specified, a default timeout of 15s is used.
       
      .google.protobuf.Duration listener_filters_timeout = 15;
      Returns:
      The listenerFiltersTimeout.
    • getListenerFiltersTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getListenerFiltersTimeoutOrBuilder()
       The timeout to wait for all listener filters to complete operation. If the timeout is reached,
       the accepted socket is closed without a connection being created unless
       ``continue_on_listener_filters_timeout`` is set to true. Specify 0 to disable the
       timeout. If not specified, a default timeout of 15s is used.
       
      .google.protobuf.Duration listener_filters_timeout = 15;
    • getContinueOnListenerFiltersTimeout

      boolean getContinueOnListenerFiltersTimeout()
       Whether a connection should be created when listener filters timeout. Default is false.
      
       .. attention::
      
       Some listener filters, such as :ref:`Proxy Protocol filter
       <config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause
       unexpected behavior when a connection is created.
       
      bool continue_on_listener_filters_timeout = 17;
      Returns:
      The continueOnListenerFiltersTimeout.
    • hasTransparent

      boolean hasTransparent()
       Whether the listener should be set as a transparent socket.
       When this flag is set to true, connections can be redirected to the listener using an
       ``iptables`` ``TPROXY`` target, in which case the original source and destination addresses and
       ports are preserved on accepted connections. This flag should be used in combination with
       :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
       <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
       "restored." This can be used to hand off each redirected connection to another listener
       associated with the connection's destination address. Direct connections to the socket without
       using ``TPROXY`` cannot be distinguished from connections redirected using ``TPROXY`` and are
       therefore treated as if they were redirected.
       When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
       Setting this flag requires Envoy to run with the ``CAP_NET_ADMIN`` capability.
       When this flag is not set (default), the socket is not modified, i.e. the transparent option
       is neither set nor reset.
       
      .google.protobuf.BoolValue transparent = 10;
      Returns:
      Whether the transparent field is set.
    • getTransparent

      com.google.protobuf.BoolValue getTransparent()
       Whether the listener should be set as a transparent socket.
       When this flag is set to true, connections can be redirected to the listener using an
       ``iptables`` ``TPROXY`` target, in which case the original source and destination addresses and
       ports are preserved on accepted connections. This flag should be used in combination with
       :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
       <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
       "restored." This can be used to hand off each redirected connection to another listener
       associated with the connection's destination address. Direct connections to the socket without
       using ``TPROXY`` cannot be distinguished from connections redirected using ``TPROXY`` and are
       therefore treated as if they were redirected.
       When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
       Setting this flag requires Envoy to run with the ``CAP_NET_ADMIN`` capability.
       When this flag is not set (default), the socket is not modified, i.e. the transparent option
       is neither set nor reset.
       
      .google.protobuf.BoolValue transparent = 10;
      Returns:
      The transparent.
    • getTransparentOrBuilder

      com.google.protobuf.BoolValueOrBuilder getTransparentOrBuilder()
       Whether the listener should be set as a transparent socket.
       When this flag is set to true, connections can be redirected to the listener using an
       ``iptables`` ``TPROXY`` target, in which case the original source and destination addresses and
       ports are preserved on accepted connections. This flag should be used in combination with
       :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
       <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
       "restored." This can be used to hand off each redirected connection to another listener
       associated with the connection's destination address. Direct connections to the socket without
       using ``TPROXY`` cannot be distinguished from connections redirected using ``TPROXY`` and are
       therefore treated as if they were redirected.
       When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
       Setting this flag requires Envoy to run with the ``CAP_NET_ADMIN`` capability.
       When this flag is not set (default), the socket is not modified, i.e. the transparent option
       is neither set nor reset.
       
      .google.protobuf.BoolValue transparent = 10;
    • hasFreebind

      boolean hasFreebind()
       Whether the listener should set the ``IP_FREEBIND`` socket option. When this
       flag is set to true, listeners can be bound to an IP address that is not
       configured on the system running Envoy. When this flag is set to false, the
       option ``IP_FREEBIND`` is disabled on the socket. When this flag is not set
       (default), the socket is not modified, i.e. the option is neither enabled
       nor disabled.
       
      .google.protobuf.BoolValue freebind = 11;
      Returns:
      Whether the freebind field is set.
    • getFreebind

      com.google.protobuf.BoolValue getFreebind()
       Whether the listener should set the ``IP_FREEBIND`` socket option. When this
       flag is set to true, listeners can be bound to an IP address that is not
       configured on the system running Envoy. When this flag is set to false, the
       option ``IP_FREEBIND`` is disabled on the socket. When this flag is not set
       (default), the socket is not modified, i.e. the option is neither enabled
       nor disabled.
       
      .google.protobuf.BoolValue freebind = 11;
      Returns:
      The freebind.
    • getFreebindOrBuilder

      com.google.protobuf.BoolValueOrBuilder getFreebindOrBuilder()
       Whether the listener should set the ``IP_FREEBIND`` socket option. When this
       flag is set to true, listeners can be bound to an IP address that is not
       configured on the system running Envoy. When this flag is set to false, the
       option ``IP_FREEBIND`` is disabled on the socket. When this flag is not set
       (default), the socket is not modified, i.e. the option is neither enabled
       nor disabled.
       
      .google.protobuf.BoolValue freebind = 11;
    • getSocketOptionsList

      List<SocketOption> getSocketOptionsList()
       Additional socket options that may not be present in Envoy source code or
       precompiled binaries. The socket options can be updated for a listener when
       :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
       is ``true``. Otherwise, if socket options change during a listener update the update will be rejected
       to make it clear that the options were not updated.
       
      repeated .envoy.config.core.v3.SocketOption socket_options = 13;
    • getSocketOptions

      SocketOption getSocketOptions(int index)
       Additional socket options that may not be present in Envoy source code or
       precompiled binaries. The socket options can be updated for a listener when
       :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
       is ``true``. Otherwise, if socket options change during a listener update the update will be rejected
       to make it clear that the options were not updated.
       
      repeated .envoy.config.core.v3.SocketOption socket_options = 13;
    • getSocketOptionsCount

      int getSocketOptionsCount()
       Additional socket options that may not be present in Envoy source code or
       precompiled binaries. The socket options can be updated for a listener when
       :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
       is ``true``. Otherwise, if socket options change during a listener update the update will be rejected
       to make it clear that the options were not updated.
       
      repeated .envoy.config.core.v3.SocketOption socket_options = 13;
    • getSocketOptionsOrBuilderList

      List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
       Additional socket options that may not be present in Envoy source code or
       precompiled binaries. The socket options can be updated for a listener when
       :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
       is ``true``. Otherwise, if socket options change during a listener update the update will be rejected
       to make it clear that the options were not updated.
       
      repeated .envoy.config.core.v3.SocketOption socket_options = 13;
    • getSocketOptionsOrBuilder

      SocketOptionOrBuilder getSocketOptionsOrBuilder(int index)
       Additional socket options that may not be present in Envoy source code or
       precompiled binaries. The socket options can be updated for a listener when
       :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
       is ``true``. Otherwise, if socket options change during a listener update the update will be rejected
       to make it clear that the options were not updated.
       
      repeated .envoy.config.core.v3.SocketOption socket_options = 13;
    • hasTcpFastOpenQueueLength

      boolean hasTcpFastOpenQueueLength()
       Whether the listener should accept TCP Fast Open (TFO) connections.
       When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
       the socket, with a queue length of the specified size
       (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
       When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
       When this flag is not set (default), the socket is not modified,
       i.e. the option is neither enabled nor disabled.
      
       On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
       TCP_FASTOPEN.
       See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
      
       On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
       To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
       
      .google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;
      Returns:
      Whether the tcpFastOpenQueueLength field is set.
    • getTcpFastOpenQueueLength

      com.google.protobuf.UInt32Value getTcpFastOpenQueueLength()
       Whether the listener should accept TCP Fast Open (TFO) connections.
       When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
       the socket, with a queue length of the specified size
       (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
       When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
       When this flag is not set (default), the socket is not modified,
       i.e. the option is neither enabled nor disabled.
      
       On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
       TCP_FASTOPEN.
       See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
      
       On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
       To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
       
      .google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;
      Returns:
      The tcpFastOpenQueueLength.
    • getTcpFastOpenQueueLengthOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getTcpFastOpenQueueLengthOrBuilder()
       Whether the listener should accept TCP Fast Open (TFO) connections.
       When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
       the socket, with a queue length of the specified size
       (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
       When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
       When this flag is not set (default), the socket is not modified,
       i.e. the option is neither enabled nor disabled.
      
       On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
       TCP_FASTOPEN.
       See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
      
       On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
       To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
       
      .google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;
    • getTrafficDirectionValue

      int getTrafficDirectionValue()
       Specifies the intended direction of the traffic relative to the local Envoy.
       This property is required on Windows for listeners using the original destination filter,
       see :ref:`Original Destination <config_listener_filters_original_dst>`.
       
      .envoy.config.core.v3.TrafficDirection traffic_direction = 16;
      Returns:
      The enum numeric value on the wire for trafficDirection.
    • getTrafficDirection

      TrafficDirection getTrafficDirection()
       Specifies the intended direction of the traffic relative to the local Envoy.
       This property is required on Windows for listeners using the original destination filter,
       see :ref:`Original Destination <config_listener_filters_original_dst>`.
       
      .envoy.config.core.v3.TrafficDirection traffic_direction = 16;
      Returns:
      The trafficDirection.
    • hasUdpListenerConfig

      boolean hasUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
       <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
       listener specific configuration.
       
      .envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
      Returns:
      Whether the udpListenerConfig field is set.
    • getUdpListenerConfig

      UdpListenerConfig getUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
       <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
       listener specific configuration.
       
      .envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
      Returns:
      The udpListenerConfig.
    • getUdpListenerConfigOrBuilder

      UdpListenerConfigOrBuilder getUdpListenerConfigOrBuilder()
       If the protocol in the listener socket address in :ref:`protocol
       <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
       <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
       listener specific configuration.
       
      .envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
    • hasApiListener

      boolean hasApiListener()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
       exposed to the non-proxy application depends on the type of API listener.
       When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
       should be set.
      
       .. note::
      
       Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
       not LDS.
      
       [#next-major-version: In the v3 API, instead of this messy approach where the socket
       listener fields are directly in the top-level Listener message and the API listener types
       are in the ApiListener message, the socket listener messages should be in their own message,
       and the top-level Listener should essentially be a oneof that selects between the
       socket listener and the various types of API listener. That way, a given Listener message
       can structurally only contain the fields of the relevant type.]
       
      .envoy.config.listener.v3.ApiListener api_listener = 19;
      Returns:
      Whether the apiListener field is set.
    • getApiListener

      ApiListener getApiListener()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
       exposed to the non-proxy application depends on the type of API listener.
       When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
       should be set.
      
       .. note::
      
       Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
       not LDS.
      
       [#next-major-version: In the v3 API, instead of this messy approach where the socket
       listener fields are directly in the top-level Listener message and the API listener types
       are in the ApiListener message, the socket listener messages should be in their own message,
       and the top-level Listener should essentially be a oneof that selects between the
       socket listener and the various types of API listener. That way, a given Listener message
       can structurally only contain the fields of the relevant type.]
       
      .envoy.config.listener.v3.ApiListener api_listener = 19;
      Returns:
      The apiListener.
    • getApiListenerOrBuilder

      ApiListenerOrBuilder getApiListenerOrBuilder()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
       exposed to the non-proxy application depends on the type of API listener.
       When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
       should be set.
      
       .. note::
      
       Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
       not LDS.
      
       [#next-major-version: In the v3 API, instead of this messy approach where the socket
       listener fields are directly in the top-level Listener message and the API listener types
       are in the ApiListener message, the socket listener messages should be in their own message,
       and the top-level Listener should essentially be a oneof that selects between the
       socket listener and the various types of API listener. That way, a given Listener message
       can structurally only contain the fields of the relevant type.]
       
      .envoy.config.listener.v3.ApiListener api_listener = 19;
    • hasConnectionBalanceConfig

      boolean hasConnectionBalanceConfig()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
       If no configuration is specified, Envoy will not attempt to balance active connections between
       worker threads.
      
       In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
       by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
       and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
       it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
       enable the balance config in Y1 and Y2 to balance the connections among the workers.
       
      .envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Returns:
      Whether the connectionBalanceConfig field is set.
    • getConnectionBalanceConfig

      Listener.ConnectionBalanceConfig getConnectionBalanceConfig()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
       If no configuration is specified, Envoy will not attempt to balance active connections between
       worker threads.
      
       In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
       by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
       and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
       it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
       enable the balance config in Y1 and Y2 to balance the connections among the workers.
       
      .envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Returns:
      The connectionBalanceConfig.
    • getConnectionBalanceConfigOrBuilder

      Listener.ConnectionBalanceConfigOrBuilder getConnectionBalanceConfigOrBuilder()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
       If no configuration is specified, Envoy will not attempt to balance active connections between
       worker threads.
      
       In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
       by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
       and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
       it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
       enable the balance config in Y1 and Y2 to balance the connections among the workers.
       
      .envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
    • getReusePort

      @Deprecated boolean getReusePort()
      Deprecated.
      envoy.config.listener.v3.Listener.reuse_port is deprecated. See envoy/config/listener/v3/listener.proto;l=312
       Deprecated. Use ``enable_reuse_port`` instead.
       
      bool reuse_port = 21 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
      Returns:
      The reusePort.
    • hasEnableReusePort

      boolean hasEnableReusePort()
       When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and
       create one socket for each worker thread. This makes inbound connections
       distribute among worker threads roughly evenly in cases where there are a high number
       of connections. When this flag is set to false, all worker threads share one socket. This field
       defaults to true. The change of field will be rejected during an listener update when the
       runtime flag ``envoy.reloadable_features.enable_update_listener_socket_options`` is enabled.
       Otherwise, the update of this field will be ignored quietly.
      
       .. attention::
      
       Although this field defaults to true, it has different behavior on different platforms. See
       the following text for more information.
      
       * On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
       with hot restart.
       * On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
       the last socket wins and receives all connections/packets. For TCP, reuse_port is force
       disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
       packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
       a single worker will currently receive packets.
       * On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
       is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
       
      .google.protobuf.BoolValue enable_reuse_port = 29;
      Returns:
      Whether the enableReusePort field is set.
    • getEnableReusePort

      com.google.protobuf.BoolValue getEnableReusePort()
       When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and
       create one socket for each worker thread. This makes inbound connections
       distribute among worker threads roughly evenly in cases where there are a high number
       of connections. When this flag is set to false, all worker threads share one socket. This field
       defaults to true. The change of field will be rejected during an listener update when the
       runtime flag ``envoy.reloadable_features.enable_update_listener_socket_options`` is enabled.
       Otherwise, the update of this field will be ignored quietly.
      
       .. attention::
      
       Although this field defaults to true, it has different behavior on different platforms. See
       the following text for more information.
      
       * On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
       with hot restart.
       * On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
       the last socket wins and receives all connections/packets. For TCP, reuse_port is force
       disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
       packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
       a single worker will currently receive packets.
       * On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
       is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
       
      .google.protobuf.BoolValue enable_reuse_port = 29;
      Returns:
      The enableReusePort.
    • getEnableReusePortOrBuilder

      com.google.protobuf.BoolValueOrBuilder getEnableReusePortOrBuilder()
       When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and
       create one socket for each worker thread. This makes inbound connections
       distribute among worker threads roughly evenly in cases where there are a high number
       of connections. When this flag is set to false, all worker threads share one socket. This field
       defaults to true. The change of field will be rejected during an listener update when the
       runtime flag ``envoy.reloadable_features.enable_update_listener_socket_options`` is enabled.
       Otherwise, the update of this field will be ignored quietly.
      
       .. attention::
      
       Although this field defaults to true, it has different behavior on different platforms. See
       the following text for more information.
      
       * On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
       with hot restart.
       * On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
       the last socket wins and receives all connections/packets. For TCP, reuse_port is force
       disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
       packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
       a single worker will currently receive packets.
       * On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
       is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
       
      .google.protobuf.BoolValue enable_reuse_port = 29;
    • getAccessLogList

      List<AccessLog> getAccessLogList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
       emitted by this listener.
       
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
    • getAccessLog

      AccessLog getAccessLog(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
       emitted by this listener.
       
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
    • getAccessLogCount

      int getAccessLogCount()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
       emitted by this listener.
       
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
    • getAccessLogOrBuilderList

      List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
       emitted by this listener.
       
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
    • getAccessLogOrBuilder

      AccessLogOrBuilder getAccessLogOrBuilder(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
       emitted by this listener.
       
      repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
    • hasTcpBacklogSize

      boolean hasTcpBacklogSize()
       The maximum length a tcp listener's pending connections queue can grow to. If no value is
       provided net.core.somaxconn will be used on Linux and 128 otherwise.
       
      .google.protobuf.UInt32Value tcp_backlog_size = 24;
      Returns:
      Whether the tcpBacklogSize field is set.
    • getTcpBacklogSize

      com.google.protobuf.UInt32Value getTcpBacklogSize()
       The maximum length a tcp listener's pending connections queue can grow to. If no value is
       provided net.core.somaxconn will be used on Linux and 128 otherwise.
       
      .google.protobuf.UInt32Value tcp_backlog_size = 24;
      Returns:
      The tcpBacklogSize.
    • getTcpBacklogSizeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getTcpBacklogSizeOrBuilder()
       The maximum length a tcp listener's pending connections queue can grow to. If no value is
       provided net.core.somaxconn will be used on Linux and 128 otherwise.
       
      .google.protobuf.UInt32Value tcp_backlog_size = 24;
    • hasMaxConnectionsToAcceptPerSocketEvent

      boolean hasMaxConnectionsToAcceptPerSocketEvent()
       The maximum number of connections to accept from the kernel per socket
       event. Envoy may decide to close these connections after accepting them
       from the kernel e.g. due to load shedding, or other policies.
       If there are more than max_connections_to_accept_per_socket_event
       connections pending accept, connections over this threshold will be
       accepted in later event loop iterations.
       If no value is provided Envoy will accept all connections pending accept
       from the kernel.
       
      .google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
      Returns:
      Whether the maxConnectionsToAcceptPerSocketEvent field is set.
    • getMaxConnectionsToAcceptPerSocketEvent

      com.google.protobuf.UInt32Value getMaxConnectionsToAcceptPerSocketEvent()
       The maximum number of connections to accept from the kernel per socket
       event. Envoy may decide to close these connections after accepting them
       from the kernel e.g. due to load shedding, or other policies.
       If there are more than max_connections_to_accept_per_socket_event
       connections pending accept, connections over this threshold will be
       accepted in later event loop iterations.
       If no value is provided Envoy will accept all connections pending accept
       from the kernel.
       
      .google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
      Returns:
      The maxConnectionsToAcceptPerSocketEvent.
    • getMaxConnectionsToAcceptPerSocketEventOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionsToAcceptPerSocketEventOrBuilder()
       The maximum number of connections to accept from the kernel per socket
       event. Envoy may decide to close these connections after accepting them
       from the kernel e.g. due to load shedding, or other policies.
       If there are more than max_connections_to_accept_per_socket_event
       connections pending accept, connections over this threshold will be
       accepted in later event loop iterations.
       If no value is provided Envoy will accept all connections pending accept
       from the kernel.
       
      .google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
    • hasBindToPort

      boolean hasBindToPort()
       Whether the listener should bind to the port. A listener that doesn't
       bind can only receive connections redirected from other listeners that set
       :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
       to true. Default is true.
       
      .google.protobuf.BoolValue bind_to_port = 26;
      Returns:
      Whether the bindToPort field is set.
    • getBindToPort

      com.google.protobuf.BoolValue getBindToPort()
       Whether the listener should bind to the port. A listener that doesn't
       bind can only receive connections redirected from other listeners that set
       :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
       to true. Default is true.
       
      .google.protobuf.BoolValue bind_to_port = 26;
      Returns:
      The bindToPort.
    • getBindToPortOrBuilder

      com.google.protobuf.BoolValueOrBuilder getBindToPortOrBuilder()
       Whether the listener should bind to the port. A listener that doesn't
       bind can only receive connections redirected from other listeners that set
       :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
       to true. Default is true.
       
      .google.protobuf.BoolValue bind_to_port = 26;
    • hasInternalListener

      boolean hasInternalListener()
       Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
       :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
       The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
       Upstream clusters refer to the internal listeners by their :ref:`name
       <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
       <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
      
       There are some limitations that are derived from the implementation. The known limitations include:
      
       * :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
       allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
       * :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
       * :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
       * :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
       
      .envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
      Returns:
      Whether the internalListener field is set.
    • getInternalListener

      Listener.InternalListenerConfig getInternalListener()
       Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
       :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
       The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
       Upstream clusters refer to the internal listeners by their :ref:`name
       <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
       <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
      
       There are some limitations that are derived from the implementation. The known limitations include:
      
       * :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
       allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
       * :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
       * :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
       * :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
       
      .envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
      Returns:
      The internalListener.
    • getInternalListenerOrBuilder

      Listener.InternalListenerConfigOrBuilder getInternalListenerOrBuilder()
       Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
       :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
       The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
       Upstream clusters refer to the internal listeners by their :ref:`name
       <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
       <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
      
       There are some limitations that are derived from the implementation. The known limitations include:
      
       * :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
       allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
       * :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
       * :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
       * :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
       
      .envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
    • getEnableMptcp

      boolean getEnableMptcp()
       Enable MPTCP (multi-path TCP) on this listener. Clients will be allowed to establish
       MPTCP connections. Non-MPTCP clients will fall back to regular TCP.
       
      bool enable_mptcp = 30;
      Returns:
      The enableMptcp.
    • getIgnoreGlobalConnLimit

      boolean getIgnoreGlobalConnLimit()
       Whether the listener should limit connections based upon the value of
       :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.
       
      bool ignore_global_conn_limit = 31;
      Returns:
      The ignoreGlobalConnLimit.
    • getBypassOverloadManager

      boolean getBypassOverloadManager()
       Whether the listener bypasses configured overload manager actions.
       
      bool bypass_overload_manager = 35;
      Returns:
      The bypassOverloadManager.
    • getListenerSpecifierCase

      Listener.ListenerSpecifierCase getListenerSpecifierCase()