public static final class Lds.Listener extends com.google.protobuf.GeneratedMessageV3 implements Lds.ListenerOrBuilder
envoy.api.v2.Listener| Modifier and Type | Class and Description |
|---|---|
static class |
Lds.Listener.Builder
Protobuf type
envoy.api.v2.Listener |
static class |
Lds.Listener.DeprecatedV1
[#not-implemented-hide:]
Protobuf type
envoy.api.v2.Listener.DeprecatedV1 |
static interface |
Lds.Listener.DeprecatedV1OrBuilder |
static class |
Lds.Listener.DrainType
Protobuf enum
envoy.api.v2.Listener.DrainType |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
ADDRESS_FIELD_NUMBER |
static int |
DEPRECATED_V1_FIELD_NUMBER |
static int |
DRAIN_TYPE_FIELD_NUMBER |
static int |
FILTER_CHAINS_FIELD_NUMBER |
static int |
FREEBIND_FIELD_NUMBER |
static int |
LISTENER_FILTERS_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER |
static int |
SOCKET_OPTIONS_FIELD_NUMBER |
static int |
TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER |
static int |
TRANSPARENT_FIELD_NUMBER |
static int |
USE_ORIGINAL_DST_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AddressOuterClass.Address |
getAddress()
The address that the listener should listen on.
|
AddressOuterClass.AddressOrBuilder |
getAddressOrBuilder()
The address that the listener should listen on.
|
static Lds.Listener |
getDefaultInstance() |
Lds.Listener |
getDefaultInstanceForType() |
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; |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.BoolValue |
getFreebind()
Whether the listener should set the *IP_FREEBIND* socket option.
|
com.google.protobuf.BoolValueOrBuilder |
getFreebindOrBuilder()
Whether the listener should set the *IP_FREEBIND* socket option.
|
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.Parser<Lds.Listener> |
getParserForType() |
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.
|
int |
getSerializedSize() |
Base.SocketOption |
getSocketOptions(int index)
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
int |
getSocketOptionsCount()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
List<Base.SocketOption> |
getSocketOptionsList()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
Base.SocketOptionOrBuilder |
getSocketOptionsOrBuilder(int index)
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
List<? extends Base.SocketOptionOrBuilder> |
getSocketOptionsOrBuilderList()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
com.google.protobuf.UInt32Value |
getTcpFastOpenQueueLength()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
com.google.protobuf.UInt32ValueOrBuilder |
getTcpFastOpenQueueLengthOrBuilder()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
com.google.protobuf.BoolValue |
getTransparent()
Whether the listener should be set as a transparent socket.
|
com.google.protobuf.BoolValueOrBuilder |
getTransparentOrBuilder()
Whether the listener should be set as a transparent socket.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
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 |
hasFreebind()
Whether the listener should set the *IP_FREEBIND* socket option.
|
int |
hashCode() |
boolean |
hasMetadata()
Listener metadata.
|
boolean |
hasPerConnectionBufferLimitBytes()
Soft limit on size of the listener’s new connection read and write buffers.
|
boolean |
hasTcpFastOpenQueueLength()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
boolean |
hasTransparent()
Whether the listener should be set as a transparent socket.
|
boolean |
hasUseOriginalDst()
Deprecated.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Lds.Listener.Builder |
newBuilder() |
static Lds.Listener.Builder |
newBuilder(Lds.Listener prototype) |
Lds.Listener.Builder |
newBuilderForType() |
protected Lds.Listener.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Lds.Listener |
parseDelimitedFrom(InputStream input) |
static Lds.Listener |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Lds.Listener |
parseFrom(byte[] data) |
static Lds.Listener |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Lds.Listener |
parseFrom(ByteBuffer data) |
static Lds.Listener |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Lds.Listener |
parseFrom(com.google.protobuf.ByteString data) |
static Lds.Listener |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Lds.Listener |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Lds.Listener |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Lds.Listener |
parseFrom(InputStream input) |
static Lds.Listener |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Lds.Listener> |
parser() |
Lds.Listener.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
public static final int FILTER_CHAINS_FIELD_NUMBER
public static final int USE_ORIGINAL_DST_FIELD_NUMBER
public static final int PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int DEPRECATED_V1_FIELD_NUMBER
public static final int DRAIN_TYPE_FIELD_NUMBER
public static final int LISTENER_FILTERS_FIELD_NUMBER
public static final int TRANSPARENT_FIELD_NUMBER
public static final int FREEBIND_FIELD_NUMBER
public static final int SOCKET_OPTIONS_FIELD_NUMBER
public static final int TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;getName in interface Lds.ListenerOrBuilderpublic 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;getNameBytes in interface Lds.ListenerOrBuilderpublic 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) = { ... }hasAddress in interface Lds.ListenerOrBuilderpublic 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) = { ... }getAddress in interface Lds.ListenerOrBuilderpublic 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) = { ... }getAddressOrBuilder in interface Lds.ListenerOrBuilderpublic 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. 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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getFilterChainsList in interface Lds.ListenerOrBuilderpublic 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. 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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getFilterChainsOrBuilderList in interface Lds.ListenerOrBuilderpublic 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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getFilterChainsCount in interface Lds.ListenerOrBuilderpublic 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. 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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getFilterChains in interface Lds.ListenerOrBuilderpublic 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. 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 [(.gogoproto.nullable) = false, (.validate.rules) = { ... }getFilterChainsOrBuilder in interface Lds.ListenerOrBuilder@Deprecated public 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. .. 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];hasUseOriginalDst in interface Lds.ListenerOrBuilder@Deprecated public 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. .. 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 in interface Lds.ListenerOrBuilder@Deprecated public 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. .. 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 in interface Lds.ListenerOrBuilderpublic 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;hasPerConnectionBufferLimitBytes in interface Lds.ListenerOrBuilderpublic 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;getPerConnectionBufferLimitBytes in interface Lds.ListenerOrBuilderpublic 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;getPerConnectionBufferLimitBytesOrBuilder in interface Lds.ListenerOrBuilderpublic boolean hasMetadata()
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;hasMetadata in interface Lds.ListenerOrBuilderpublic Base.Metadata getMetadata()
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;getMetadata in interface Lds.ListenerOrBuilderpublic Base.MetadataOrBuilder getMetadataOrBuilder()
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;getMetadataOrBuilder in interface Lds.ListenerOrBuilderpublic boolean hasDeprecatedV1()
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;hasDeprecatedV1 in interface Lds.ListenerOrBuilderpublic Lds.Listener.DeprecatedV1 getDeprecatedV1()
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;getDeprecatedV1 in interface Lds.ListenerOrBuilderpublic Lds.Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;getDeprecatedV1OrBuilder in interface Lds.ListenerOrBuilderpublic int getDrainTypeValue()
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;getDrainTypeValue in interface Lds.ListenerOrBuilderpublic Lds.Listener.DrainType getDrainType()
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;getDrainType in interface Lds.ListenerOrBuilderpublic 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];getListenerFiltersList in interface Lds.ListenerOrBuilderpublic 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];getListenerFiltersOrBuilderList in interface Lds.ListenerOrBuilderpublic 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];getListenerFiltersCount in interface Lds.ListenerOrBuilderpublic 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];getListenerFilters in interface Lds.ListenerOrBuilderpublic 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];getListenerFiltersOrBuilder in interface Lds.ListenerOrBuilderpublic 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;hasTransparent in interface Lds.ListenerOrBuilderpublic 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;getTransparent in interface Lds.ListenerOrBuilderpublic 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;getTransparentOrBuilder in interface Lds.ListenerOrBuilderpublic 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;hasFreebind in interface Lds.ListenerOrBuilderpublic 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;getFreebind in interface Lds.ListenerOrBuilderpublic 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;getFreebindOrBuilder in interface Lds.ListenerOrBuilderpublic List<Base.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;getSocketOptionsList in interface Lds.ListenerOrBuilderpublic List<? extends Base.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;getSocketOptionsOrBuilderList in interface Lds.ListenerOrBuilderpublic 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;getSocketOptionsCount in interface Lds.ListenerOrBuilderpublic Base.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;getSocketOptions in interface Lds.ListenerOrBuilderpublic Base.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;getSocketOptionsOrBuilder in interface Lds.ListenerOrBuilderpublic 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;hasTcpFastOpenQueueLength in interface Lds.ListenerOrBuilderpublic 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;getTcpFastOpenQueueLength in interface Lds.ListenerOrBuilderpublic 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;getTcpFastOpenQueueLengthOrBuilder in interface Lds.ListenerOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Lds.Listener parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Lds.Listener parseFrom(InputStream input) throws IOException
IOExceptionpublic static Lds.Listener parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Lds.Listener parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Lds.Listener parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Lds.Listener parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Lds.Listener parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Lds.Listener.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Lds.Listener.Builder newBuilder()
public static Lds.Listener.Builder newBuilder(Lds.Listener prototype)
public Lds.Listener.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Lds.Listener.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Lds.Listener getDefaultInstance()
public static com.google.protobuf.Parser<Lds.Listener> parser()
public com.google.protobuf.Parser<Lds.Listener> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Lds.Listener getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2018 The Envoy Project. All rights reserved.