io.envoyproxy.envoy.api.v2.listener

Class FilterChain

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.api.v2.listener.FilterChain

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterChainOrBuilder, Serializable

public final class FilterChain
extends com.google.protobuf.GeneratedMessageV3
implements FilterChainOrBuilder

 A filter chain wraps a set of match criteria, an option TLS context, a set of filters, and
 various other parameters.
 [#next-free-field: 8]
 

Protobuf type envoy.api.v2.listener.FilterChain

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterChain.Builder A filter chain wraps a set of match criteria, an option TLS context, a set of filters, and various other parameters.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_CHAIN_MATCH_FIELD_NUMBER
static int	FILTERS_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TLS_CONTEXT_FIELD_NUMBER
static int	TRANSPORT_SOCKET_FIELD_NUMBER
static int	USE_PROXY_PROTO_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FilterChain	getDefaultInstance()
FilterChain	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FilterChainMatch	getFilterChainMatch() The criteria to use when matching a connection to this filter chain.
FilterChainMatchOrBuilder	getFilterChainMatchOrBuilder() The criteria to use when matching a connection to this filter chain.
Filter	getFilters(int index) A list of individual network filters that make up the filter chain for connections established with the listener.
int	getFiltersCount() A list of individual network filters that make up the filter chain for connections established with the listener.
List<Filter>	getFiltersList() A list of individual network filters that make up the filter chain for connections established with the listener.
FilterOrBuilder	getFiltersOrBuilder(int index) A list of individual network filters that make up the filter chain for connections established with the listener.
List<? extends FilterOrBuilder>	getFiltersOrBuilderList() A list of individual network filters that make up the filter chain for connections established with the listener.
Metadata	getMetadata() [#not-implemented-hide:] filter chain metadata.
MetadataOrBuilder	getMetadataOrBuilder() [#not-implemented-hide:] filter chain metadata.
String	getName() [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.
com.google.protobuf.ByteString	getNameBytes() [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.
com.google.protobuf.Parser<FilterChain>	getParserForType()
int	getSerializedSize()
DownstreamTlsContext	getTlsContext() Deprecated.
DownstreamTlsContextOrBuilder	getTlsContextOrBuilder() Deprecated.
TransportSocket	getTransportSocket() Optional custom transport socket implementation to use for downstream connections.
TransportSocketOrBuilder	getTransportSocketOrBuilder() Optional custom transport socket implementation to use for downstream connections.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.BoolValue	getUseProxyProto() Whether the listener should expect a PROXY protocol V1 header on new connections.
com.google.protobuf.BoolValueOrBuilder	getUseProxyProtoOrBuilder() Whether the listener should expect a PROXY protocol V1 header on new connections.
boolean	hasFilterChainMatch() The criteria to use when matching a connection to this filter chain.
int	hashCode()
boolean	hasMetadata() [#not-implemented-hide:] filter chain metadata.
boolean	hasTlsContext() Deprecated.
boolean	hasTransportSocket() Optional custom transport socket implementation to use for downstream connections.
boolean	hasUseProxyProto() Whether the listener should expect a PROXY protocol V1 header on new connections.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FilterChain.Builder	newBuilder()
static FilterChain.Builder	newBuilder(FilterChain prototype)
FilterChain.Builder	newBuilderForType()
protected FilterChain.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FilterChain	parseDelimitedFrom(InputStream input)
static FilterChain	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterChain	parseFrom(byte[] data)
static FilterChain	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterChain	parseFrom(ByteBuffer data)
static FilterChain	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterChain	parseFrom(com.google.protobuf.ByteString data)
static FilterChain	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterChain	parseFrom(com.google.protobuf.CodedInputStream input)
static FilterChain	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FilterChain	parseFrom(InputStream input)
static FilterChain	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FilterChain>	parser()
FilterChain.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FILTER_CHAIN_MATCH_FIELD_NUMBER

public static final int FILTER_CHAIN_MATCH_FIELD_NUMBER

See Also:

Constant Field Values

TLS_CONTEXT_FIELD_NUMBER

public static final int TLS_CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

FILTERS_FIELD_NUMBER

public static final int FILTERS_FIELD_NUMBER

See Also:

Constant Field Values

USE_PROXY_PROTO_FIELD_NUMBER

public static final int USE_PROXY_PROTO_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

TRANSPORT_SOCKET_FIELD_NUMBER

public static final int TRANSPORT_SOCKET_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasFilterChainMatch

public boolean hasFilterChainMatch()

 The criteria to use when matching a connection to this filter chain.
 

.envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;

Specified by:

hasFilterChainMatch in interface FilterChainOrBuilder

getFilterChainMatch

public FilterChainMatch getFilterChainMatch()

 The criteria to use when matching a connection to this filter chain.
 

.envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;

Specified by:

getFilterChainMatch in interface FilterChainOrBuilder

getFilterChainMatchOrBuilder

public FilterChainMatchOrBuilder getFilterChainMatchOrBuilder()

 The criteria to use when matching a connection to this filter chain.
 

.envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;

Specified by:

getFilterChainMatchOrBuilder in interface FilterChainOrBuilder

hasTlsContext

@Deprecated
public boolean hasTlsContext()

Deprecated.

 The TLS context for this filter chain.
 .. attention::
   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
 

.envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];

Specified by:

hasTlsContext in interface FilterChainOrBuilder

getTlsContext

@Deprecated
public DownstreamTlsContext getTlsContext()

Deprecated.

 The TLS context for this filter chain.
 .. attention::
   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
 

.envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];

Specified by:

getTlsContext in interface FilterChainOrBuilder

getTlsContextOrBuilder

@Deprecated
public DownstreamTlsContextOrBuilder getTlsContextOrBuilder()

Deprecated.

 The TLS context for this filter chain.
 .. attention::
   **This field is deprecated**. Use `transport_socket` with name `tls` instead. If both are
   set, `transport_socket` takes priority.
 

.envoy.api.v2.auth.DownstreamTlsContext tls_context = 2 [deprecated = true];

Specified by:

getTlsContextOrBuilder in interface FilterChainOrBuilder

getFiltersList

public List<Filter> getFiltersList()

 A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
 

repeated .envoy.api.v2.listener.Filter filters = 3;

Specified by:

getFiltersList in interface FilterChainOrBuilder

getFiltersOrBuilderList

public List<? extends FilterOrBuilder> getFiltersOrBuilderList()

 A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
 

repeated .envoy.api.v2.listener.Filter filters = 3;

Specified by:

getFiltersOrBuilderList in interface FilterChainOrBuilder

getFiltersCount

public int getFiltersCount()

 A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
 

repeated .envoy.api.v2.listener.Filter filters = 3;

Specified by:

getFiltersCount in interface FilterChainOrBuilder

getFilters

public Filter getFilters(int index)

 A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
 

repeated .envoy.api.v2.listener.Filter filters = 3;

Specified by:

getFilters in interface FilterChainOrBuilder

getFiltersOrBuilder

public FilterOrBuilder getFiltersOrBuilder(int index)

 A list of individual network filters that make up the filter chain for
 connections established with the listener. Order matters as the filters are
 processed sequentially as connection events happen. Note: If the filter
 list is empty, the connection will close by default.
 

repeated .envoy.api.v2.listener.Filter filters = 3;

Specified by:

getFiltersOrBuilder in interface FilterChainOrBuilder

hasUseProxyProto

public boolean hasUseProxyProto()

 Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 

.google.protobuf.BoolValue use_proxy_proto = 4;

Specified by:

hasUseProxyProto in interface FilterChainOrBuilder

getUseProxyProto

public com.google.protobuf.BoolValue getUseProxyProto()

 Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 

.google.protobuf.BoolValue use_proxy_proto = 4;

Specified by:

getUseProxyProto in interface FilterChainOrBuilder

getUseProxyProtoOrBuilder

public com.google.protobuf.BoolValueOrBuilder getUseProxyProtoOrBuilder()

 Whether the listener should expect a PROXY protocol V1 header on new
 connections. If this option is enabled, the listener will assume that that
 remote address of the connection is the one specified in the header. Some
 load balancers including the AWS ELB support this option. If the option is
 absent or set to false, Envoy will use the physical peer address of the
 connection as the remote address.
 

.google.protobuf.BoolValue use_proxy_proto = 4;

Specified by:

getUseProxyProtoOrBuilder in interface FilterChainOrBuilder

hasMetadata

public boolean hasMetadata()

 [#not-implemented-hide:] filter chain metadata.
 

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

Specified by:

hasMetadata in interface FilterChainOrBuilder

getMetadata

public Metadata getMetadata()

 [#not-implemented-hide:] filter chain metadata.
 

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

Specified by:

getMetadata in interface FilterChainOrBuilder

getMetadataOrBuilder

public MetadataOrBuilder getMetadataOrBuilder()

 [#not-implemented-hide:] filter chain metadata.
 

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

Specified by:

getMetadataOrBuilder in interface FilterChainOrBuilder

hasTransportSocket

public boolean hasTransportSocket()

 Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 

.envoy.api.v2.core.TransportSocket transport_socket = 6;

Specified by:

hasTransportSocket in interface FilterChainOrBuilder

getTransportSocket

public TransportSocket getTransportSocket()

 Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 

.envoy.api.v2.core.TransportSocket transport_socket = 6;

Specified by:

getTransportSocket in interface FilterChainOrBuilder

getTransportSocketOrBuilder

public TransportSocketOrBuilder getTransportSocketOrBuilder()

 Optional custom transport socket implementation to use for downstream connections.
 To setup TLS, set a transport socket with name `tls` and
 :ref:`DownstreamTlsContext <envoy_api_msg_auth.DownstreamTlsContext>` in the `typed_config`.
 If no transport socket configuration is specified, new connections
 will be set up with plaintext.
 

.envoy.api.v2.core.TransportSocket transport_socket = 6;

Specified by:

getTransportSocketOrBuilder in interface FilterChainOrBuilder

getName

public String getName()

 [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known. If no
 name is provided, Envoy will allocate an internal UUID for the filter chain. If the filter
 chain is to be dynamically updated or removed via FCDS a unique name must be provided.
 

string name = 7;

Specified by:

getName in interface FilterChainOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 [#not-implemented-hide:] The unique name (or empty) by which this filter chain is known. If no
 name is provided, Envoy will allocate an internal UUID for the filter chain. If the filter
 chain is to be dynamically updated or removed via FCDS a unique name must be provided.
 

string name = 7;

Specified by:

getNameBytes in interface FilterChainOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FilterChain parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FilterChain parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FilterChain parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FilterChain parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FilterChain parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static FilterChain parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FilterChain.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FilterChain.Builder newBuilder()

newBuilder

public static FilterChain.Builder newBuilder(FilterChain prototype)

toBuilder

public FilterChain.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FilterChain.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FilterChain getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FilterChain> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FilterChain getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder