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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA 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<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic FilterChainstatic final com.google.protobuf.Descriptors.DescriptorThe criteria to use when matching a connection to this filter chain.The criteria to use when matching a connection to this filter chain.getFilters(int index) A list of individual network filters that make up the filter chain for connections established with the listener.intA list of individual network filters that make up the filter chain for connections established with the listener.A list of individual network filters that make up the filter chain for connections established with the listener.getFiltersOrBuilder(int index) A list of individual network filters that make up the filter chain for connections established with the listener.List<? extends FilterOrBuilder>A list of individual network filters that make up the filter chain for connections established with the listener.[#not-implemented-hide:] filter chain metadata.[#not-implemented-hide:] filter chain metadata.getName()[#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.com.google.protobuf.ByteString[#not-implemented-hide:] The unique name (or empty) by which this filter chain is known.com.google.protobuf.Parser<FilterChain>intDeprecated.envoy.api.v2.listener.FilterChain.tls_context is deprecated.Deprecated.Optional custom transport socket implementation to use for downstream connections.Optional custom transport socket implementation to use for downstream connections.com.google.protobuf.BoolValueWhether the listener should expect a PROXY protocol V1 header on new connections.com.google.protobuf.BoolValueOrBuilderWhether the listener should expect a PROXY protocol V1 header on new connections.booleanThe criteria to use when matching a connection to this filter chain.inthashCode()boolean[#not-implemented-hide:] filter chain metadata.booleanDeprecated.envoy.api.v2.listener.FilterChain.tls_context is deprecated.booleanOptional custom transport socket implementation to use for downstream connections.booleanWhether the listener should expect a PROXY protocol V1 header on new connections.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic FilterChain.Builderstatic FilterChain.BuildernewBuilder(FilterChain prototype) protected FilterChain.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static FilterChainparseDelimitedFrom(InputStream input) static FilterChainparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterChainparseFrom(byte[] data) static FilterChainparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterChainparseFrom(com.google.protobuf.ByteString data) static FilterChainparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterChainparseFrom(com.google.protobuf.CodedInputStream input) static FilterChainparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterChainparseFrom(InputStream input) static FilterChainparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterChainparseFrom(ByteBuffer data) static FilterChainparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FilterChain>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
FILTER_CHAIN_MATCH_FIELD_NUMBER
public static final int FILTER_CHAIN_MATCH_FIELD_NUMBER- See Also:
-
TLS_CONTEXT_FIELD_NUMBER
public static final int TLS_CONTEXT_FIELD_NUMBER- See Also:
-
FILTERS_FIELD_NUMBER
public static final int FILTERS_FIELD_NUMBER- See Also:
-
USE_PROXY_PROTO_FIELD_NUMBER
public static final int USE_PROXY_PROTO_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
TRANSPORT_SOCKET_FIELD_NUMBER
public static final int TRANSPORT_SOCKET_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
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
-
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:
hasFilterChainMatchin interfaceFilterChainOrBuilder- Returns:
- Whether the filterChainMatch field is set.
-
getFilterChainMatch
The criteria to use when matching a connection to this filter chain.
.envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;- Specified by:
getFilterChainMatchin interfaceFilterChainOrBuilder- Returns:
- The filterChainMatch.
-
getFilterChainMatchOrBuilder
The criteria to use when matching a connection to this filter chain.
.envoy.api.v2.listener.FilterChainMatch filter_chain_match = 1;- Specified by:
getFilterChainMatchOrBuilderin interfaceFilterChainOrBuilder
-
hasTlsContext
Deprecated.envoy.api.v2.listener.FilterChain.tls_context is deprecated. See envoy/api/v2/listener/listener_components.proto;l=180The 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:
hasTlsContextin interfaceFilterChainOrBuilder- Returns:
- Whether the tlsContext field is set.
-
getTlsContext
Deprecated.envoy.api.v2.listener.FilterChain.tls_context is deprecated. See envoy/api/v2/listener/listener_components.proto;l=180The 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:
getTlsContextin interfaceFilterChainOrBuilder- Returns:
- The tlsContext.
-
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:
getTlsContextOrBuilderin interfaceFilterChainOrBuilder
-
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:
getFiltersListin interfaceFilterChainOrBuilder
-
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:
getFiltersOrBuilderListin interfaceFilterChainOrBuilder
-
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:
getFiltersCountin interfaceFilterChainOrBuilder
-
getFilters
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:
getFiltersin interfaceFilterChainOrBuilder
-
getFiltersOrBuilder
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:
getFiltersOrBuilderin interfaceFilterChainOrBuilder
-
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:
hasUseProxyProtoin interfaceFilterChainOrBuilder- Returns:
- Whether the useProxyProto field is set.
-
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:
getUseProxyProtoin interfaceFilterChainOrBuilder- Returns:
- The useProxyProto.
-
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:
getUseProxyProtoOrBuilderin interfaceFilterChainOrBuilder
-
hasMetadata
public boolean hasMetadata()[#not-implemented-hide:] filter chain metadata.
.envoy.api.v2.core.Metadata metadata = 5;- Specified by:
hasMetadatain interfaceFilterChainOrBuilder- Returns:
- Whether the metadata field is set.
-
getMetadata
[#not-implemented-hide:] filter chain metadata.
.envoy.api.v2.core.Metadata metadata = 5;- Specified by:
getMetadatain interfaceFilterChainOrBuilder- Returns:
- The metadata.
-
getMetadataOrBuilder
[#not-implemented-hide:] filter chain metadata.
.envoy.api.v2.core.Metadata metadata = 5;- Specified by:
getMetadataOrBuilderin interfaceFilterChainOrBuilder
-
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:
hasTransportSocketin interfaceFilterChainOrBuilder- Returns:
- Whether the transportSocket field is set.
-
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:
getTransportSocketin interfaceFilterChainOrBuilder- Returns:
- The transportSocket.
-
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:
getTransportSocketOrBuilderin interfaceFilterChainOrBuilder
-
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:
getNamein interfaceFilterChainOrBuilder- Returns:
- The name.
-
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:
getNameBytesin interfaceFilterChainOrBuilder- Returns:
- The bytes for name.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static FilterChain parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static FilterChain parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FilterChain parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FilterChain.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-