Package io.envoyproxy.envoy.api.v2
Class Listener.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
io.envoyproxy.envoy.api.v2.Listener.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ListenerOrBuilder,Cloneable
- Enclosing class:
- Listener
public static final class Listener.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
implements ListenerOrBuilder
[#next-free-field: 23]Protobuf type
envoy.api.v2.Listener-
Method Summary
Modifier and TypeMethodDescriptionaddAccessLog(int index, AccessLog value) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAccessLog(int index, AccessLog.Builder builderForValue) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAccessLog(AccessLog value) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAccessLog(AccessLog.Builder builderForValue) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAccessLogBuilder(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAllAccessLog(Iterable<? extends AccessLog> values) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.addAllFilterChains(Iterable<? extends FilterChain> values) A list of filter chains to consider for this listener.addAllListenerFilters(Iterable<? extends ListenerFilter> values) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addAllSocketOptions(Iterable<? extends SocketOption> values) Additional socket options that may not be present in Envoy source code or precompiled binaries.addFilterChains(int index, FilterChain value) A list of filter chains to consider for this listener.addFilterChains(int index, FilterChain.Builder builderForValue) A list of filter chains to consider for this listener.addFilterChains(FilterChain value) A list of filter chains to consider for this listener.addFilterChains(FilterChain.Builder builderForValue) A list of filter chains to consider for this listener.A list of filter chains to consider for this listener.addFilterChainsBuilder(int index) A list of filter chains to consider for this listener.addListenerFilters(int index, ListenerFilter value) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addListenerFilters(int index, ListenerFilter.Builder builderForValue) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addListenerFilters(ListenerFilter value) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addListenerFilters(ListenerFilter.Builder builderForValue) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addListenerFiltersBuilder(int index) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addSocketOptions(int index, SocketOption value) Additional socket options that may not be present in Envoy source code or precompiled binaries.addSocketOptions(int index, SocketOption.Builder builderForValue) Additional socket options that may not be present in Envoy source code or precompiled binaries.addSocketOptions(SocketOption value) Additional socket options that may not be present in Envoy source code or precompiled binaries.addSocketOptions(SocketOption.Builder builderForValue) Additional socket options that may not be present in Envoy source code or precompiled binaries.Additional socket options that may not be present in Envoy source code or precompiled binaries.addSocketOptionsBuilder(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.build()clear()Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.The address that the listener should listen on.Used to represent an API listener, which is used in non-proxy clients.The listener's connection balancer configuration, currently only applicable to TCP listeners.Whether a connection should be created when listener filters timeout.[#not-implemented-hide:]The type of draining to perform at a listener-wide level.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) A list of filter chains to consider for this listener.Whether the listener should set the *IP_FREEBIND* socket option.Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.The timeout to wait for all listener filters to complete operation.Listener metadata.The unique name by which this listener is known.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Soft limit on size of the listener’s new connection read and write buffers.When this flag is set to true, listeners set the *SO_REUSEPORT* socket option and create one socket for each worker thread.Additional socket options that may not be present in Envoy source code or precompiled binaries.Whether the listener should accept TCP Fast Open (TFO) connections.Specifies the intended direction of the traffic relative to the local Envoy.Whether the listener should be set as a transparent socket.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.Deprecated.clone()getAccessLog(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.getAccessLogBuilder(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.intConfiguration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.getAccessLogOrBuilder(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.List<? extends AccessLogOrBuilder>Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.The address that the listener should listen on.The address that the listener should listen on.The address that the listener should listen on.Used to represent an API listener, which is used in non-proxy clients.Used to represent an API listener, which is used in non-proxy clients.Used to represent an API listener, which is used in non-proxy clients.The listener's connection balancer configuration, currently only applicable to TCP listeners.The listener's connection balancer configuration, currently only applicable to TCP listeners.The listener's connection balancer configuration, currently only applicable to TCP listeners.booleanWhether a connection should be created when listener filters timeout.[#not-implemented-hide:][#not-implemented-hide:][#not-implemented-hide:]static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe type of draining to perform at a listener-wide level.intThe type of draining to perform at a listener-wide level.getFilterChains(int index) A list of filter chains to consider for this listener.getFilterChainsBuilder(int index) A list of filter chains to consider for this listener.A list of filter chains to consider for this listener.intA list of filter chains to consider for this listener.A list of filter chains to consider for this listener.getFilterChainsOrBuilder(int index) A list of filter chains to consider for this listener.List<? extends FilterChainOrBuilder>A list of filter chains to consider for this listener.com.google.protobuf.BoolValueWhether the listener should set the *IP_FREEBIND* socket option.com.google.protobuf.BoolValue.BuilderWhether the listener should set the *IP_FREEBIND* socket option.com.google.protobuf.BoolValueOrBuilderWhether the listener should set the *IP_FREEBIND* socket option.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.getListenerFiltersBuilder(int index) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.intListener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.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 ListenerFilterOrBuilder>Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.com.google.protobuf.DurationThe timeout to wait for all listener filters to complete operation.com.google.protobuf.Duration.BuilderThe timeout to wait for all listener filters to complete operation.com.google.protobuf.DurationOrBuilderThe timeout to wait for all listener filters to complete operation.Listener metadata.Listener metadata.Listener metadata.getName()The unique name by which this listener is known.com.google.protobuf.ByteStringThe unique name by which this listener is known.com.google.protobuf.UInt32ValueSoft limit on size of the listener’s new connection read and write buffers.com.google.protobuf.UInt32Value.BuilderSoft limit on size of the listener’s new connection read and write buffers.com.google.protobuf.UInt32ValueOrBuilderSoft limit on size of the listener’s new connection read and write buffers.booleanWhen this flag is set to true, listeners set the *SO_REUSEPORT* socket option and create one socket for each worker thread.getSocketOptions(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.getSocketOptionsBuilder(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.Additional socket options that may not be present in Envoy source code or precompiled binaries.intAdditional socket options that may not be present in Envoy source code or precompiled binaries.Additional socket options that may not be present in Envoy source code or precompiled binaries.getSocketOptionsOrBuilder(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.List<? extends SocketOptionOrBuilder>Additional socket options that may not be present in Envoy source code or precompiled binaries.com.google.protobuf.UInt32ValueWhether the listener should accept TCP Fast Open (TFO) connections.com.google.protobuf.UInt32Value.BuilderWhether the listener should accept TCP Fast Open (TFO) connections.com.google.protobuf.UInt32ValueOrBuilderWhether the listener should accept TCP Fast Open (TFO) connections.Specifies the intended direction of the traffic relative to the local Envoy.intSpecifies the intended direction of the traffic relative to the local Envoy.com.google.protobuf.BoolValueWhether the listener should be set as a transparent socket.com.google.protobuf.BoolValue.BuilderWhether the listener should be set as a transparent socket.com.google.protobuf.BoolValueOrBuilderWhether the listener should be set as a transparent socket.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.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.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.com.google.protobuf.BoolValueDeprecated.envoy.api.v2.Listener.use_original_dst is deprecated.com.google.protobuf.BoolValue.BuilderDeprecated.com.google.protobuf.BoolValueOrBuilderDeprecated.booleanThe address that the listener should listen on.booleanUsed to represent an API listener, which is used in non-proxy clients.booleanThe listener's connection balancer configuration, currently only applicable to TCP listeners.boolean[#not-implemented-hide:]booleanWhether the listener should set the *IP_FREEBIND* socket option.booleanThe timeout to wait for all listener filters to complete operation.booleanListener metadata.booleanSoft limit on size of the listener’s new connection read and write buffers.booleanWhether the listener should accept TCP Fast Open (TFO) connections.booleanWhether the listener should be set as a transparent socket.booleanIf 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.booleanDeprecated.envoy.api.v2.Listener.use_original_dst is deprecated.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeAddress(Address value) The address that the listener should listen on.mergeApiListener(ApiListener value) Used to represent an API listener, which is used in non-proxy clients.The listener's connection balancer configuration, currently only applicable to TCP listeners.[#not-implemented-hide:]mergeFreebind(com.google.protobuf.BoolValue value) Whether the listener should set the *IP_FREEBIND* socket option.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeListenerFiltersTimeout(com.google.protobuf.Duration value) The timeout to wait for all listener filters to complete operation.mergeMetadata(Metadata value) Listener metadata.mergePerConnectionBufferLimitBytes(com.google.protobuf.UInt32Value value) Soft limit on size of the listener’s new connection read and write buffers.mergeTcpFastOpenQueueLength(com.google.protobuf.UInt32Value value) Whether the listener should accept TCP Fast Open (TFO) connections.mergeTransparent(com.google.protobuf.BoolValue value) Whether the listener should be set as a transparent socket.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.final Listener.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) mergeUseOriginalDst(com.google.protobuf.BoolValue value) Deprecated.removeAccessLog(int index) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.removeFilterChains(int index) A list of filter chains to consider for this listener.removeListenerFilters(int index) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.removeSocketOptions(int index) Additional socket options that may not be present in Envoy source code or precompiled binaries.setAccessLog(int index, AccessLog value) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.setAccessLog(int index, AccessLog.Builder builderForValue) Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.setAddress(Address value) The address that the listener should listen on.setAddress(Address.Builder builderForValue) The address that the listener should listen on.setApiListener(ApiListener value) Used to represent an API listener, which is used in non-proxy clients.setApiListener(ApiListener.Builder builderForValue) Used to represent an API listener, which is used in non-proxy clients.The listener's connection balancer configuration, currently only applicable to TCP listeners.setConnectionBalanceConfig(Listener.ConnectionBalanceConfig.Builder builderForValue) The listener's connection balancer configuration, currently only applicable to TCP listeners.setContinueOnListenerFiltersTimeout(boolean value) Whether a connection should be created when listener filters timeout.[#not-implemented-hide:]setDeprecatedV1(Listener.DeprecatedV1.Builder builderForValue) [#not-implemented-hide:]setDrainType(Listener.DrainType value) The type of draining to perform at a listener-wide level.setDrainTypeValue(int value) The type of draining to perform at a listener-wide level.setFilterChains(int index, FilterChain value) A list of filter chains to consider for this listener.setFilterChains(int index, FilterChain.Builder builderForValue) A list of filter chains to consider for this listener.setFreebind(com.google.protobuf.BoolValue value) Whether the listener should set the *IP_FREEBIND* socket option.setFreebind(com.google.protobuf.BoolValue.Builder builderForValue) Whether the listener should set the *IP_FREEBIND* socket option.setListenerFilters(int index, ListenerFilter value) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.setListenerFilters(int index, ListenerFilter.Builder builderForValue) Listener filters have the opportunity to manipulate and augment the connection metadata that is used in connection filter chain matching, for example.setListenerFiltersTimeout(com.google.protobuf.Duration value) The timeout to wait for all listener filters to complete operation.setListenerFiltersTimeout(com.google.protobuf.Duration.Builder builderForValue) The timeout to wait for all listener filters to complete operation.setMetadata(Metadata value) Listener metadata.setMetadata(Metadata.Builder builderForValue) Listener metadata.The unique name by which this listener is known.setNameBytes(com.google.protobuf.ByteString value) The unique name by which this listener is known.setPerConnectionBufferLimitBytes(com.google.protobuf.UInt32Value value) Soft limit on size of the listener’s new connection read and write buffers.setPerConnectionBufferLimitBytes(com.google.protobuf.UInt32Value.Builder builderForValue) Soft limit on size of the listener’s new connection read and write buffers.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setReusePort(boolean value) When this flag is set to true, listeners set the *SO_REUSEPORT* socket option and create one socket for each worker thread.setSocketOptions(int index, SocketOption value) Additional socket options that may not be present in Envoy source code or precompiled binaries.setSocketOptions(int index, SocketOption.Builder builderForValue) Additional socket options that may not be present in Envoy source code or precompiled binaries.setTcpFastOpenQueueLength(com.google.protobuf.UInt32Value value) Whether the listener should accept TCP Fast Open (TFO) connections.setTcpFastOpenQueueLength(com.google.protobuf.UInt32Value.Builder builderForValue) Whether the listener should accept TCP Fast Open (TFO) connections.Specifies the intended direction of the traffic relative to the local Envoy.setTrafficDirectionValue(int value) Specifies the intended direction of the traffic relative to the local Envoy.setTransparent(com.google.protobuf.BoolValue value) Whether the listener should be set as a transparent socket.setTransparent(com.google.protobuf.BoolValue.Builder builderForValue) Whether the listener should be set as a transparent socket.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.setUdpListenerConfig(UdpListenerConfig.Builder builderForValue) 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.final Listener.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setUseOriginalDst(com.google.protobuf.BoolValue value) Deprecated.setUseOriginalDst(com.google.protobuf.BoolValue.Builder builderForValue) Deprecated.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
setField
public Listener.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
setRepeatedField
public Listener.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
addRepeatedField
public Listener.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Listener.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
mergeFrom
public Listener.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Listener.Builder>- Throws:
IOException
-
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:
getNamein interfaceListenerOrBuilder- 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:
getNameBytesin interfaceListenerOrBuilder- Returns:
- The bytes for name.
-
setName
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;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
The unique name by which this listener is known. If no name is provided, Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
string name = 1;- Returns:
- This builder for chaining.
-
setNameBytes
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;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
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:
hasAddressin interfaceListenerOrBuilder- Returns:
- Whether the address field is set.
-
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:
getAddressin interfaceListenerOrBuilder- Returns:
- The address.
-
setAddress
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) = { ... } -
setAddress
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) = { ... } -
mergeAddress
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) = { ... } -
clearAddress
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) = { ... } -
getAddressBuilder
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) = { ... } -
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:
getAddressOrBuilderin interfaceListenerOrBuilder
-
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:
getFilterChainsListin interfaceListenerOrBuilder
-
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:
getFilterChainsCountin interfaceListenerOrBuilder
-
getFilterChains
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:
getFilterChainsin interfaceListenerOrBuilder
-
setFilterChains
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; -
setFilterChains
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; -
addFilterChains
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; -
addFilterChains
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; -
addFilterChains
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; -
addFilterChains
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; -
addAllFilterChains
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; -
clearFilterChains
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; -
removeFilterChains
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; -
getFilterChainsBuilder
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; -
getFilterChainsOrBuilder
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:
getFilterChainsOrBuilderin interfaceListenerOrBuilder
-
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:
getFilterChainsOrBuilderListin interfaceListenerOrBuilder
-
addFilterChainsBuilder
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; -
addFilterChainsBuilder
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; -
getFilterChainsBuilderList
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; -
hasUseOriginalDst
Deprecated.envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112If 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:
hasUseOriginalDstin interfaceListenerOrBuilder- Returns:
- Whether the useOriginalDst field is set.
-
getUseOriginalDst
Deprecated.envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112If 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:
getUseOriginalDstin interfaceListenerOrBuilder- Returns:
- The useOriginalDst.
-
setUseOriginalDst
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]; -
setUseOriginalDst
@Deprecated public Listener.Builder setUseOriginalDst(com.google.protobuf.BoolValue.Builder builderForValue) 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]; -
mergeUseOriginalDst
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]; -
clearUseOriginalDst
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]; -
getUseOriginalDstBuilder
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.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:
getUseOriginalDstOrBuilderin interfaceListenerOrBuilder
-
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:
hasPerConnectionBufferLimitBytesin interfaceListenerOrBuilder- 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:
getPerConnectionBufferLimitBytesin interfaceListenerOrBuilder- Returns:
- The perConnectionBufferLimitBytes.
-
setPerConnectionBufferLimitBytes
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; -
setPerConnectionBufferLimitBytes
public Listener.Builder setPerConnectionBufferLimitBytes(com.google.protobuf.UInt32Value.Builder builderForValue) 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; -
mergePerConnectionBufferLimitBytes
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; -
clearPerConnectionBufferLimitBytes
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; -
getPerConnectionBufferLimitBytesBuilder
public com.google.protobuf.UInt32Value.Builder getPerConnectionBufferLimitBytesBuilder()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
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:
getPerConnectionBufferLimitBytesOrBuilderin interfaceListenerOrBuilder
-
hasMetadata
public boolean hasMetadata()Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;- Specified by:
hasMetadatain interfaceListenerOrBuilder- Returns:
- Whether the metadata field is set.
-
getMetadata
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;- Specified by:
getMetadatain interfaceListenerOrBuilder- Returns:
- The metadata.
-
setMetadata
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6; -
setMetadata
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6; -
mergeMetadata
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6; -
clearMetadata
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6; -
getMetadataBuilder
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6; -
getMetadataOrBuilder
Listener metadata.
.envoy.api.v2.core.Metadata metadata = 6;- Specified by:
getMetadataOrBuilderin interfaceListenerOrBuilder
-
hasDeprecatedV1
public boolean hasDeprecatedV1()[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;- Specified by:
hasDeprecatedV1in interfaceListenerOrBuilder- Returns:
- Whether the deprecatedV1 field is set.
-
getDeprecatedV1
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;- Specified by:
getDeprecatedV1in interfaceListenerOrBuilder- Returns:
- The deprecatedV1.
-
setDeprecatedV1
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7; -
setDeprecatedV1
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7; -
mergeDeprecatedV1
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7; -
clearDeprecatedV1
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7; -
getDeprecatedV1Builder
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7; -
getDeprecatedV1OrBuilder
[#not-implemented-hide:]
.envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;- Specified by:
getDeprecatedV1OrBuilderin interfaceListenerOrBuilder
-
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:
getDrainTypeValuein interfaceListenerOrBuilder- Returns:
- The enum numeric value on the wire for drainType.
-
setDrainTypeValue
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;- Parameters:
value- The enum numeric value on the wire for drainType to set.- Returns:
- This builder for chaining.
-
getDrainType
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;- Specified by:
getDrainTypein interfaceListenerOrBuilder- Returns:
- The drainType.
-
setDrainType
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;- Parameters:
value- The drainType to set.- Returns:
- This builder for chaining.
-
clearDrainType
The type of draining to perform at a listener-wide level.
.envoy.api.v2.Listener.DrainType drain_type = 8;- Returns:
- This builder for chaining.
-
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:
getListenerFiltersListin interfaceListenerOrBuilder
-
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:
getListenerFiltersCountin interfaceListenerOrBuilder
-
getListenerFilters
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:
getListenerFiltersin interfaceListenerOrBuilder
-
setListenerFilters
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; -
setListenerFilters
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; -
addListenerFilters
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; -
addListenerFilters
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; -
addListenerFilters
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; -
addListenerFilters
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; -
addAllListenerFilters
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; -
clearListenerFilters
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; -
removeListenerFilters
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; -
getListenerFiltersBuilder
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; -
getListenerFiltersOrBuilder
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:
getListenerFiltersOrBuilderin interfaceListenerOrBuilder
-
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:
getListenerFiltersOrBuilderListin interfaceListenerOrBuilder
-
addListenerFiltersBuilder
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; -
addListenerFiltersBuilder
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; -
getListenerFiltersBuilderList
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; -
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:
hasListenerFiltersTimeoutin interfaceListenerOrBuilder- 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:
getListenerFiltersTimeoutin interfaceListenerOrBuilder- Returns:
- The listenerFiltersTimeout.
-
setListenerFiltersTimeout
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; -
setListenerFiltersTimeout
public Listener.Builder setListenerFiltersTimeout(com.google.protobuf.Duration.Builder builderForValue) 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; -
mergeListenerFiltersTimeout
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; -
clearListenerFiltersTimeout
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; -
getListenerFiltersTimeoutBuilder
public com.google.protobuf.Duration.Builder getListenerFiltersTimeoutBuilder()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; -
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:
getListenerFiltersTimeoutOrBuilderin interfaceListenerOrBuilder
-
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:
getContinueOnListenerFiltersTimeoutin interfaceListenerOrBuilder- Returns:
- The continueOnListenerFiltersTimeout.
-
setContinueOnListenerFiltersTimeout
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;- Parameters:
value- The continueOnListenerFiltersTimeout to set.- Returns:
- This builder for chaining.
-
clearContinueOnListenerFiltersTimeout
Whether a connection should be created when listener filters timeout. Default is false. .. attention:: Some listener filters, such as :ref:`Proxy Protocol filter <config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause unexpected behavior when a connection is created.
bool continue_on_listener_filters_timeout = 17;- Returns:
- This builder for chaining.
-
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:
hasTransparentin interfaceListenerOrBuilder- 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:
getTransparentin interfaceListenerOrBuilder- Returns:
- The transparent.
-
setTransparent
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; -
setTransparent
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; -
mergeTransparent
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; -
clearTransparent
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; -
getTransparentBuilder
public com.google.protobuf.BoolValue.Builder getTransparentBuilder()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
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:
getTransparentOrBuilderin interfaceListenerOrBuilder
-
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:
hasFreebindin interfaceListenerOrBuilder- 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:
getFreebindin interfaceListenerOrBuilder- Returns:
- The freebind.
-
setFreebind
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; -
setFreebind
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; -
mergeFreebind
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; -
clearFreebind
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; -
getFreebindBuilder
public com.google.protobuf.BoolValue.Builder getFreebindBuilder()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
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:
getFreebindOrBuilderin interfaceListenerOrBuilder
-
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:
getSocketOptionsListin interfaceListenerOrBuilder
-
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:
getSocketOptionsCountin interfaceListenerOrBuilder
-
getSocketOptions
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:
getSocketOptionsin interfaceListenerOrBuilder
-
setSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
setSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addAllSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
clearSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
removeSocketOptions
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
getSocketOptionsBuilder
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
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:
getSocketOptionsOrBuilderin interfaceListenerOrBuilder
-
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:
getSocketOptionsOrBuilderListin interfaceListenerOrBuilder
-
addSocketOptionsBuilder
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
addSocketOptionsBuilder
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
getSocketOptionsBuilderList
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.api.v2.core.SocketOption socket_options = 13; -
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:
hasTcpFastOpenQueueLengthin interfaceListenerOrBuilder- 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:
getTcpFastOpenQueueLengthin interfaceListenerOrBuilder- Returns:
- The tcpFastOpenQueueLength.
-
setTcpFastOpenQueueLength
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; -
setTcpFastOpenQueueLength
public Listener.Builder setTcpFastOpenQueueLength(com.google.protobuf.UInt32Value.Builder builderForValue) 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; -
mergeTcpFastOpenQueueLength
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; -
clearTcpFastOpenQueueLength
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; -
getTcpFastOpenQueueLengthBuilder
public com.google.protobuf.UInt32Value.Builder getTcpFastOpenQueueLengthBuilder()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
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:
getTcpFastOpenQueueLengthOrBuilderin interfaceListenerOrBuilder
-
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:
getTrafficDirectionValuein interfaceListenerOrBuilder- Returns:
- The enum numeric value on the wire for trafficDirection.
-
setTrafficDirectionValue
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;- Parameters:
value- The enum numeric value on the wire for trafficDirection to set.- Returns:
- This builder for chaining.
-
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:
getTrafficDirectionin interfaceListenerOrBuilder- Returns:
- The trafficDirection.
-
setTrafficDirection
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;- Parameters:
value- The trafficDirection to set.- Returns:
- This builder for chaining.
-
clearTrafficDirection
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;- Returns:
- This builder for chaining.
-
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:
hasUdpListenerConfigin interfaceListenerOrBuilder- Returns:
- Whether the udpListenerConfig field is set.
-
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:
getUdpListenerConfigin interfaceListenerOrBuilder- Returns:
- The udpListenerConfig.
-
setUdpListenerConfig
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; -
setUdpListenerConfig
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; -
mergeUdpListenerConfig
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; -
clearUdpListenerConfig
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; -
getUdpListenerConfigBuilder
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; -
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:
getUdpListenerConfigOrBuilderin interfaceListenerOrBuilder
-
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:
hasApiListenerin interfaceListenerOrBuilder- Returns:
- Whether the apiListener field is set.
-
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:
getApiListenerin interfaceListenerOrBuilder- Returns:
- The apiListener.
-
setApiListener
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; -
setApiListener
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; -
mergeApiListener
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; -
clearApiListener
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; -
getApiListenerBuilder
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; -
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:
getApiListenerOrBuilderin interfaceListenerOrBuilder
-
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:
hasConnectionBalanceConfigin interfaceListenerOrBuilder- Returns:
- Whether the connectionBalanceConfig field is set.
-
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:
getConnectionBalanceConfigin interfaceListenerOrBuilder- Returns:
- The connectionBalanceConfig.
-
setConnectionBalanceConfig
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; -
setConnectionBalanceConfig
public Listener.Builder setConnectionBalanceConfig(Listener.ConnectionBalanceConfig.Builder builderForValue) 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; -
mergeConnectionBalanceConfig
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; -
clearConnectionBalanceConfig
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; -
getConnectionBalanceConfigBuilder
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; -
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:
getConnectionBalanceConfigOrBuilderin interfaceListenerOrBuilder
-
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:
getReusePortin interfaceListenerOrBuilder- Returns:
- The reusePort.
-
setReusePort
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;- Parameters:
value- The reusePort to set.- Returns:
- This builder for chaining.
-
clearReusePort
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;- Returns:
- This builder for chaining.
-
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:
getAccessLogListin interfaceListenerOrBuilder
-
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:
getAccessLogCountin interfaceListenerOrBuilder
-
getAccessLog
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:
getAccessLogin interfaceListenerOrBuilder
-
setAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
setAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAllAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
clearAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
removeAccessLog
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
getAccessLogBuilder
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
getAccessLogOrBuilder
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:
getAccessLogOrBuilderin interfaceListenerOrBuilder
-
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:
getAccessLogOrBuilderListin interfaceListenerOrBuilder
-
addAccessLogBuilder
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
addAccessLogBuilder
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
getAccessLogBuilderList
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22; -
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Listener.Builder>
-