envoy.api.v2

Interface Lds.ListenerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Lds.Listener, Lds.Listener.Builder

Enclosing class:

Lds

public static interface Lds.ListenerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AddressOuterClass.Address	getAddress() The address that the listener should listen on.
AddressOuterClass.AddressOrBuilder	getAddressOrBuilder() The address that the listener should listen on.
Lds.Listener.DeprecatedV1	getDeprecatedV1() [#not-implemented-hide:] .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
Lds.Listener.DeprecatedV1OrBuilder	getDeprecatedV1OrBuilder() [#not-implemented-hide:] .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
Lds.Listener.DrainType	getDrainType() The type of draining to perform at a listener-wide level.
int	getDrainTypeValue() The type of draining to perform at a listener-wide level.
Listener.FilterChain	getFilterChains(int index) A list of filter chains to consider for this listener.
int	getFilterChainsCount() A list of filter chains to consider for this listener.
List<Listener.FilterChain>	getFilterChainsList() A list of filter chains to consider for this listener.
Listener.FilterChainOrBuilder	getFilterChainsOrBuilder(int index) A list of filter chains to consider for this listener.
List<? extends Listener.FilterChainOrBuilder>	getFilterChainsOrBuilderList() A list of filter chains to consider for this listener.
Listener.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.
int	getListenerFiltersCount() Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.
List<Listener.ListenerFilter>	getListenerFiltersList() Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.
Listener.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.
List<? extends Listener.ListenerFilterOrBuilder>	getListenerFiltersOrBuilderList() Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.
Base.Metadata	getMetadata() Listener metadata.
Base.MetadataOrBuilder	getMetadataOrBuilder() Listener metadata.
String	getName() The unique name by which this listener is known.
com.google.protobuf.ByteString	getNameBytes() The unique name by which this listener is known.
com.google.protobuf.UInt32Value	getPerConnectionBufferLimitBytes() Soft limit on size of the listener’s new connection read and write buffers.
com.google.protobuf.UInt32ValueOrBuilder	getPerConnectionBufferLimitBytesOrBuilder() Soft limit on size of the listener’s new connection read and write buffers.
com.google.protobuf.BoolValue	getUseOriginalDst() Deprecated.
com.google.protobuf.BoolValueOrBuilder	getUseOriginalDstOrBuilder() Deprecated.
boolean	hasAddress() The address that the listener should listen on.
boolean	hasDeprecatedV1() [#not-implemented-hide:] .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
boolean	hasMetadata() Listener metadata.
boolean	hasPerConnectionBufferLimitBytes() Soft limit on size of the listener’s new connection read and write buffers.
boolean	hasUseOriginalDst() Deprecated.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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.
 By default, the maximum length of a listener's name is limited to 60 characters. This limit can
 be increased by setting the :option:`--max-obj-name-len` command line argument to the desired
 value.
 

string name = 1;

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.
 By default, the maximum length of a listener's name is limited to 60 characters. This limit can
 be increased by setting the :option:`--max-obj-name-len` command line argument to the desired
 value.
 

string name = 1;

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.
 

.envoy.api.v2.core.Address address = 2 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getAddress

AddressOuterClass.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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getAddressOrBuilder

AddressOuterClass.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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getFilterChainsList

List<Listener.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.
 .. attention::
   In the current version, multiple filter chains are supported **only** so that SNI can be
   configured. See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
   information. When multiple filter chains are configured, each filter chain must have an
   **identical** set of :ref:`filters <envoy_api_field_listener.FilterChain.filters>`. If the
   filters differ, the configuration will fail to load. In the future, this limitation will be
   relaxed such that different filters can be used depending on which filter chain matches
   (based on SNI or some other parameter).
 

repeated .envoy.api.v2.listener.FilterChain filter_chains = 3 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getFilterChains

Listener.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.
 .. attention::
   In the current version, multiple filter chains are supported **only** so that SNI can be
   configured. See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
   information. When multiple filter chains are configured, each filter chain must have an
   **identical** set of :ref:`filters <envoy_api_field_listener.FilterChain.filters>`. If the
   filters differ, the configuration will fail to load. In the future, this limitation will be
   relaxed such that different filters can be used depending on which filter chain matches
   (based on SNI or some other parameter).
 

repeated .envoy.api.v2.listener.FilterChain filter_chains = 3 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getFilterChainsCount

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.
 .. attention::
   In the current version, multiple filter chains are supported **only** so that SNI can be
   configured. See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
   information. When multiple filter chains are configured, each filter chain must have an
   **identical** set of :ref:`filters <envoy_api_field_listener.FilterChain.filters>`. If the
   filters differ, the configuration will fail to load. In the future, this limitation will be
   relaxed such that different filters can be used depending on which filter chain matches
   (based on SNI or some other parameter).
 

repeated .envoy.api.v2.listener.FilterChain filter_chains = 3 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getFilterChainsOrBuilderList

List<? extends Listener.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.
 .. attention::
   In the current version, multiple filter chains are supported **only** so that SNI can be
   configured. See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
   information. When multiple filter chains are configured, each filter chain must have an
   **identical** set of :ref:`filters <envoy_api_field_listener.FilterChain.filters>`. If the
   filters differ, the configuration will fail to load. In the future, this limitation will be
   relaxed such that different filters can be used depending on which filter chain matches
   (based on SNI or some other parameter).
 

repeated .envoy.api.v2.listener.FilterChain filter_chains = 3 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

getFilterChainsOrBuilder

Listener.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.
 .. attention::
   In the current version, multiple filter chains are supported **only** so that SNI can be
   configured. See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
   information. When multiple filter chains are configured, each filter chain must have an
   **identical** set of :ref:`filters <envoy_api_field_listener.FilterChain.filters>`. If the
   filters differ, the configuration will fail to load. In the future, this limitation will be
   relaxed such that different filters can be used depending on which filter chain matches
   (based on SNI or some other parameter).
 

repeated .envoy.api.v2.listener.FilterChain filter_chains = 3 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }

hasUseOriginalDst

@Deprecated
boolean hasUseOriginalDst()

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];

getUseOriginalDst

@Deprecated
com.google.protobuf.BoolValue getUseOriginalDst()

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];

getUseOriginalDstOrBuilder

@Deprecated
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];

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;

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;

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;

hasMetadata

boolean hasMetadata()

 Listener metadata.
 

.envoy.api.v2.core.Metadata metadata = 6;

getMetadata

Base.Metadata getMetadata()

 Listener metadata.
 

.envoy.api.v2.core.Metadata metadata = 6;

getMetadataOrBuilder

Base.MetadataOrBuilder getMetadataOrBuilder()

 Listener metadata.
 

.envoy.api.v2.core.Metadata metadata = 6;

hasDeprecatedV1

boolean hasDeprecatedV1()

 [#not-implemented-hide:]
 

.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;

getDeprecatedV1

Lds.Listener.DeprecatedV1 getDeprecatedV1()

 [#not-implemented-hide:]
 

.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;

getDeprecatedV1OrBuilder

Lds.Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()

 [#not-implemented-hide:]
 

.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;

getDrainTypeValue

int getDrainTypeValue()

 The type of draining to perform at a listener-wide level.
 

.envoy.api.v2.Listener.DrainType drain_type = 8;

getDrainType

Lds.Listener.DrainType getDrainType()

 The type of draining to perform at a listener-wide level.
 

.envoy.api.v2.Listener.DrainType drain_type = 8;

getListenerFiltersList

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

repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9 [(.gogoproto.nullable) = false];

getListenerFilters

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

repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9 [(.gogoproto.nullable) = false];

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

repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9 [(.gogoproto.nullable) = false];

getListenerFiltersOrBuilderList

List<? extends Listener.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.
 

repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9 [(.gogoproto.nullable) = false];

getListenerFiltersOrBuilder

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

repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9 [(.gogoproto.nullable) = false];