Package io.envoyproxy.envoy.api.v2

Class Listener

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.Listener
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListenerOrBuilder, Serializable
public final class Listener extends com.google.protobuf.GeneratedMessageV3 implements ListenerOrBuilder
 [#next-free-field: 23]
Protobuf type envoy.api.v2.Listener
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • FILTER_CHAINS_FIELD_NUMBER

      public static final int FILTER_CHAINS_FIELD_NUMBER
      See Also:

    • USE_ORIGINAL_DST_FIELD_NUMBER

      public static final int USE_ORIGINAL_DST_FIELD_NUMBER
      See Also:

    • PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER

      public static final int PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • DEPRECATED_V1_FIELD_NUMBER

      public static final int DEPRECATED_V1_FIELD_NUMBER
      See Also:

    • DRAIN_TYPE_FIELD_NUMBER

      public static final int DRAIN_TYPE_FIELD_NUMBER
      See Also:

    • LISTENER_FILTERS_FIELD_NUMBER

      public static final int LISTENER_FILTERS_FIELD_NUMBER
      See Also:

    • LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER

      public static final int LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
      See Also:

    • CONTINUE_ON_LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER

      public static final int CONTINUE_ON_LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
      See Also:

    • TRANSPARENT_FIELD_NUMBER

      public static final int TRANSPARENT_FIELD_NUMBER
      See Also:

    • FREEBIND_FIELD_NUMBER

      public static final int FREEBIND_FIELD_NUMBER
      See Also:

    • SOCKET_OPTIONS_FIELD_NUMBER

      public static final int SOCKET_OPTIONS_FIELD_NUMBER
      See Also:

    • TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER

      public static final int TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER
      See Also:

    • TRAFFIC_DIRECTION_FIELD_NUMBER

      public static final int TRAFFIC_DIRECTION_FIELD_NUMBER
      See Also:

    • UDP_LISTENER_CONFIG_FIELD_NUMBER

      public static final int UDP_LISTENER_CONFIG_FIELD_NUMBER
      See Also:

    • API_LISTENER_FIELD_NUMBER

      public static final int API_LISTENER_FIELD_NUMBER
      See Also:

    • CONNECTION_BALANCE_CONFIG_FIELD_NUMBER

      public static final int CONNECTION_BALANCE_CONFIG_FIELD_NUMBER
      See Also:

    • REUSE_PORT_FIELD_NUMBER

      public static final int REUSE_PORT_FIELD_NUMBER
      See Also:

    • ACCESS_LOG_FIELD_NUMBER

      public static final int ACCESS_LOG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public 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;
      Specified by:
      getName in interface ListenerOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface ListenerOrBuilder
      Returns:
      The bytes for name.

    • hasAddress

      public 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.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }
      Specified by:
      hasAddress in interface ListenerOrBuilder
      Returns:
      Whether the address field is set.

    • getAddress

      public 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.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }
      Specified by:
      getAddress in interface ListenerOrBuilder
      Returns:
      The address.

    • getAddressOrBuilder

      public 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.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }
      Specified by:
      getAddressOrBuilder in interface ListenerOrBuilder

    • getFilterChainsList

      public List<FilterChain> getFilterChainsList()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;
      Specified by:
      getFilterChainsList in interface ListenerOrBuilder

    • getFilterChainsOrBuilderList

      public List<? extends FilterChainOrBuilder> getFilterChainsOrBuilderList()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;
      Specified by:
      getFilterChainsOrBuilderList in interface ListenerOrBuilder

    • getFilterChainsCount

      public int getFilterChainsCount()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;
      Specified by:
      getFilterChainsCount in interface ListenerOrBuilder

    • getFilterChains

      public FilterChain getFilterChains(int index)
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;
      Specified by:
      getFilterChains in interface ListenerOrBuilder

    • getFilterChainsOrBuilder

      public FilterChainOrBuilder getFilterChainsOrBuilder(int index)
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;
      Specified by:
      getFilterChainsOrBuilder in interface ListenerOrBuilder

    • hasUseOriginalDst

      @Deprecated public boolean hasUseOriginalDst()
      Deprecated.
      envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];
      Specified by:
      hasUseOriginalDst in interface ListenerOrBuilder
      Returns:
      Whether the useOriginalDst field is set.

    • getUseOriginalDst

      @Deprecated public com.google.protobuf.BoolValue getUseOriginalDst()
      Deprecated.
      envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];
      Specified by:
      getUseOriginalDst in interface ListenerOrBuilder
      Returns:
      The useOriginalDst.

    • getUseOriginalDstOrBuilder

      @Deprecated public com.google.protobuf.BoolValueOrBuilder getUseOriginalDstOrBuilder()
      Deprecated.
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];
      Specified by:
      getUseOriginalDstOrBuilder in interface ListenerOrBuilder

    • hasPerConnectionBufferLimitBytes

      public 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;
      Specified by:
      hasPerConnectionBufferLimitBytes in interface ListenerOrBuilder
      Returns:
      Whether the perConnectionBufferLimitBytes field is set.

    • getPerConnectionBufferLimitBytes

      public 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;
      Specified by:
      getPerConnectionBufferLimitBytes in interface ListenerOrBuilder
      Returns:
      The perConnectionBufferLimitBytes.

    • getPerConnectionBufferLimitBytesOrBuilder

      public 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;
      Specified by:
      getPerConnectionBufferLimitBytesOrBuilder in interface ListenerOrBuilder

    • hasMetadata

      public boolean hasMetadata()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;
      Specified by:
      hasMetadata in interface ListenerOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public Metadata getMetadata()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;
      Specified by:
      getMetadata in interface ListenerOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public MetadataOrBuilder getMetadataOrBuilder()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;
      Specified by:
      getMetadataOrBuilder in interface ListenerOrBuilder

    • hasDeprecatedV1

      public boolean hasDeprecatedV1()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
      Specified by:
      hasDeprecatedV1 in interface ListenerOrBuilder
      Returns:
      Whether the deprecatedV1 field is set.

    • getDeprecatedV1

      public Listener.DeprecatedV1 getDeprecatedV1()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
      Specified by:
      getDeprecatedV1 in interface ListenerOrBuilder
      Returns:
      The deprecatedV1.

    • getDeprecatedV1OrBuilder

      public Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
      Specified by:
      getDeprecatedV1OrBuilder in interface ListenerOrBuilder

    • getDrainTypeValue

      public int getDrainTypeValue()
       The type of draining to perform at a listener-wide level.
      .envoy.api.v2.Listener.DrainType drain_type = 8;
      Specified by:
      getDrainTypeValue in interface ListenerOrBuilder
      Returns:
      The enum numeric value on the wire for drainType.

    • getDrainType

      public Listener.DrainType getDrainType()
       The type of draining to perform at a listener-wide level.
      .envoy.api.v2.Listener.DrainType drain_type = 8;
      Specified by:
      getDrainType in interface ListenerOrBuilder
      Returns:
      The drainType.

    • getListenerFiltersList

      public 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_api_field_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_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;
      Specified by:
      getListenerFiltersList in interface ListenerOrBuilder

    • getListenerFiltersOrBuilderList

      public 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_api_field_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_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;
      Specified by:
      getListenerFiltersOrBuilderList in interface ListenerOrBuilder

    • getListenerFiltersCount

      public 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_api_field_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_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;
      Specified by:
      getListenerFiltersCount in interface ListenerOrBuilder

    • getListenerFilters

      public 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_api_field_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_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;
      Specified by:
      getListenerFilters in interface ListenerOrBuilder

    • getListenerFiltersOrBuilder

      public 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_api_field_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_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;
      Specified by:
      getListenerFiltersOrBuilder in interface ListenerOrBuilder

    • hasListenerFiltersTimeout

      public 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;
      Specified by:
      hasListenerFiltersTimeout in interface ListenerOrBuilder
      Returns:
      Whether the listenerFiltersTimeout field is set.

    • getListenerFiltersTimeout

      public 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;
      Specified by:
      getListenerFiltersTimeout in interface ListenerOrBuilder
      Returns:
      The listenerFiltersTimeout.

    • getListenerFiltersTimeoutOrBuilder

      public 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;
      Specified by:
      getListenerFiltersTimeoutOrBuilder in interface ListenerOrBuilder

    • getContinueOnListenerFiltersTimeout

      public 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;
      Specified by:
      getContinueOnListenerFiltersTimeout in interface ListenerOrBuilder
      Returns:
      The continueOnListenerFiltersTimeout.

    • hasTransparent

      public 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_api_field_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;
      Specified by:
      hasTransparent in interface ListenerOrBuilder
      Returns:
      Whether the transparent field is set.

    • getTransparent

      public 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_api_field_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;
      Specified by:
      getTransparent in interface ListenerOrBuilder
      Returns:
      The transparent.

    • getTransparentOrBuilder

      public 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_api_field_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;
      Specified by:
      getTransparentOrBuilder in interface ListenerOrBuilder

    • hasFreebind

      public 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;
      Specified by:
      hasFreebind in interface ListenerOrBuilder
      Returns:
      Whether the freebind field is set.

    • getFreebind

      public 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;
      Specified by:
      getFreebind in interface ListenerOrBuilder
      Returns:
      The freebind.

    • getFreebindOrBuilder

      public 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;
      Specified by:
      getFreebindOrBuilder in interface ListenerOrBuilder

    • getSocketOptionsList

      public List<SocketOption> getSocketOptionsList()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;
      Specified by:
      getSocketOptionsList in interface ListenerOrBuilder

    • getSocketOptionsOrBuilderList

      public List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;
      Specified by:
      getSocketOptionsOrBuilderList in interface ListenerOrBuilder

    • getSocketOptionsCount

      public int getSocketOptionsCount()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;
      Specified by:
      getSocketOptionsCount in interface ListenerOrBuilder

    • getSocketOptions

      public SocketOption getSocketOptions(int index)
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;
      Specified by:
      getSocketOptions in interface ListenerOrBuilder

    • getSocketOptionsOrBuilder

      public SocketOptionOrBuilder getSocketOptionsOrBuilder(int index)
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;
      Specified by:
      getSocketOptionsOrBuilder in interface ListenerOrBuilder

    • hasTcpFastOpenQueueLength

      public 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;
      Specified by:
      hasTcpFastOpenQueueLength in interface ListenerOrBuilder
      Returns:
      Whether the tcpFastOpenQueueLength field is set.

    • getTcpFastOpenQueueLength

      public 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;
      Specified by:
      getTcpFastOpenQueueLength in interface ListenerOrBuilder
      Returns:
      The tcpFastOpenQueueLength.

    • getTcpFastOpenQueueLengthOrBuilder

      public 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;
      Specified by:
      getTcpFastOpenQueueLengthOrBuilder in interface ListenerOrBuilder

    • getTrafficDirectionValue

      public 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.api.v2.core.TrafficDirection traffic_direction = 16;
      Specified by:
      getTrafficDirectionValue in interface ListenerOrBuilder
      Returns:
      The enum numeric value on the wire for trafficDirection.

    • getTrafficDirection

      public 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.api.v2.core.TrafficDirection traffic_direction = 16;
      Specified by:
      getTrafficDirection in interface ListenerOrBuilder
      Returns:
      The trafficDirection.

    • hasUdpListenerConfig

      public boolean hasUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;
      Specified by:
      hasUdpListenerConfig in interface ListenerOrBuilder
      Returns:
      Whether the udpListenerConfig field is set.

    • getUdpListenerConfig

      public UdpListenerConfig getUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;
      Specified by:
      getUdpListenerConfig in interface ListenerOrBuilder
      Returns:
      The udpListenerConfig.

    • getUdpListenerConfigOrBuilder

      public UdpListenerConfigOrBuilder getUdpListenerConfigOrBuilder()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;
      Specified by:
      getUdpListenerConfigOrBuilder in interface ListenerOrBuilder

    • hasApiListener

      public 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_api_field_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.v2.ApiListener api_listener = 19;
      Specified by:
      hasApiListener in interface ListenerOrBuilder
      Returns:
      Whether the apiListener field is set.

    • getApiListener

      public 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_api_field_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.v2.ApiListener api_listener = 19;
      Specified by:
      getApiListener in interface ListenerOrBuilder
      Returns:
      The apiListener.

    • getApiListenerOrBuilder

      public 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_api_field_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.v2.ApiListener api_listener = 19;
      Specified by:
      getApiListenerOrBuilder in interface ListenerOrBuilder

    • hasConnectionBalanceConfig

      public 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.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Specified by:
      hasConnectionBalanceConfig in interface ListenerOrBuilder
      Returns:
      Whether the connectionBalanceConfig field is set.

    • getConnectionBalanceConfig

      public 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.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Specified by:
      getConnectionBalanceConfig in interface ListenerOrBuilder
      Returns:
      The connectionBalanceConfig.

    • getConnectionBalanceConfigOrBuilder

      public 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.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Specified by:
      getConnectionBalanceConfigOrBuilder in interface ListenerOrBuilder

    • getReusePort

      public boolean getReusePort()
       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.

 Before Linux v4.19-rc1, new TCP connections may be rejected during hot restart
 (see `3rd paragraph in 'soreuseport' commit message
 <https://github.com/torvalds/linux/commit/c617f398edd4db2b8567a28e89>`_).
 This issue was fixed by `tcp: Avoid TCP syncookie rejected by SO_REUSEPORT socket
 <https://github.com/torvalds/linux/commit/40a1227ea845a37ab197dd1caffb60b047fa36b1>`_.
      bool reuse_port = 21;
      Specified by:
      getReusePort in interface ListenerOrBuilder
      Returns:
      The reusePort.

    • getAccessLogList

      public List<AccessLog> getAccessLogList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;
      Specified by:
      getAccessLogList in interface ListenerOrBuilder

    • getAccessLogOrBuilderList

      public List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;
      Specified by:
      getAccessLogOrBuilderList in interface ListenerOrBuilder

    • getAccessLogCount

      public int getAccessLogCount()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;
      Specified by:
      getAccessLogCount in interface ListenerOrBuilder

    • getAccessLog

      public AccessLog getAccessLog(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;
      Specified by:
      getAccessLog in interface ListenerOrBuilder

    • getAccessLogOrBuilder

      public AccessLogOrBuilder getAccessLogOrBuilder(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;
      Specified by:
      getAccessLogOrBuilder in interface ListenerOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Listener parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Listener parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Listener parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Listener parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Listener parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Listener parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Listener parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Listener.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Listener.Builder newBuilder()

    • newBuilder

      public static Listener.Builder newBuilder(Listener prototype)

    • toBuilder

      public Listener.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Listener.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Listener getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Listener> parser()

    • getParserForType

      public com.google.protobuf.Parser<Listener> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Listener getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder