FilterChainMatch (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.envoyproxy.envoy.config.listener.v3.FilterChainMatch

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterChainMatchOrBuilder, Serializable

public final class FilterChainMatch
extends com.google.protobuf.GeneratedMessageV3
implements FilterChainMatchOrBuilder

Specifies the match criteria for selecting a specific filter chain for a
listener.
In order for a filter chain to be selected, *ALL* of its criteria must be
fulfilled by the incoming connection, properties of which are set by the
networking stack and/or listener filters.
The following order applies:
1. Destination port.
2. Destination IP address.
3. Server name (e.g. SNI for TLS protocol),
4. Transport protocol.
5. Application protocols (e.g. ALPN for TLS protocol).
6. Source type (e.g. any, local or external network).
7. Source IP address.
8. Source port.
For criteria that allow ranges or wildcards, the most specific value in any
of the configured filter chains that matches the incoming connection is going
to be used (e.g. for SNI ``www.example.com`` the most specific match would be
``www.example.com``, then ``*.example.com``, then ``*.com``, then any filter
chain without ``server_names`` requirements).
A different way to reason about the filter chain matches:
Suppose there exists N filter chains. Prune the filter chain set using the above 8 steps.
In each step, filter chains which most specifically matches the attributes continue to the next step.
The listener guarantees at most 1 filter chain is left after all of the steps.
Example:
For destination port, filter chains specifying the destination port of incoming traffic are the
most specific match. If none of the filter chains specifies the exact destination port, the filter
chains which do not specify ports are the most specific match. Filter chains specifying the
wrong port can never be the most specific match.
[#comment: Implemented rules are kept in the preference order, with deprecated fields
listed at the end, because that's how we want to list them in the docs.
[#comment:TODO(PiotrSikora): Add support for configurable precedence of the rules]
[#next-free-field: 13]

Protobuf type envoy.config.listener.v3.FilterChainMatch

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FilterChainMatch.Builder` Specifies the match criteria for selecting a specific filter chain for a listener.
`static class`	`FilterChainMatch.ConnectionSourceType` Protobuf enum `envoy.config.listener.v3.FilterChainMatch.ConnectionSourceType`

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`	`ADDRESS_SUFFIX_FIELD_NUMBER`
`static int`	`APPLICATION_PROTOCOLS_FIELD_NUMBER`
`static int`	`DESTINATION_PORT_FIELD_NUMBER`
`static int`	`PREFIX_RANGES_FIELD_NUMBER`
`static int`	`SERVER_NAMES_FIELD_NUMBER`
`static int`	`SOURCE_PORTS_FIELD_NUMBER`
`static int`	`SOURCE_PREFIX_RANGES_FIELD_NUMBER`
`static int`	`SOURCE_TYPE_FIELD_NUMBER`
`static int`	`SUFFIX_LEN_FIELD_NUMBER`
`static int`	`TRANSPORT_PROTOCOL_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAddressSuffix()` If non-empty, an IP address and suffix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`com.google.protobuf.ByteString`	`getAddressSuffixBytes()` If non-empty, an IP address and suffix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`String`	`getApplicationProtocols(int index)` If non-empty, a list of application protocols (e.g.
`com.google.protobuf.ByteString`	`getApplicationProtocolsBytes(int index)` If non-empty, a list of application protocols (e.g.
`int`	`getApplicationProtocolsCount()` If non-empty, a list of application protocols (e.g.
`com.google.protobuf.ProtocolStringList`	`getApplicationProtocolsList()` If non-empty, a list of application protocols (e.g.
`static FilterChainMatch`	`getDefaultInstance()`
`FilterChainMatch`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.UInt32Value`	`getDestinationPort()` Optional destination port to consider when use_original_dst is set on the listener in determining a filter chain match.
`com.google.protobuf.UInt32ValueOrBuilder`	`getDestinationPortOrBuilder()` Optional destination port to consider when use_original_dst is set on the listener in determining a filter chain match.
`com.google.protobuf.Parser<FilterChainMatch>`	`getParserForType()`
`CidrRange`	`getPrefixRanges(int index)` If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`int`	`getPrefixRangesCount()` If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`List<CidrRange>`	`getPrefixRangesList()` If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`CidrRangeOrBuilder`	`getPrefixRangesOrBuilder(int index)` If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`List<? extends CidrRangeOrBuilder>`	`getPrefixRangesOrBuilderList()` If non-empty, an IP address and prefix length to match addresses when the listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
`int`	`getSerializedSize()`
`String`	`getServerNames(int index)` If non-empty, a list of server names (e.g.
`com.google.protobuf.ByteString`	`getServerNamesBytes(int index)` If non-empty, a list of server names (e.g.
`int`	`getServerNamesCount()` If non-empty, a list of server names (e.g.
`com.google.protobuf.ProtocolStringList`	`getServerNamesList()` If non-empty, a list of server names (e.g.
`int`	`getSourcePorts(int index)` The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ports.
`int`	`getSourcePortsCount()` The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ports.
`List<Integer>`	`getSourcePortsList()` The criteria is satisfied if the source port of the downstream connection is contained in at least one of the specified ports.
`CidrRange`	`getSourcePrefixRanges(int index)` The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets.
`int`	`getSourcePrefixRangesCount()` The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets.
`List<CidrRange>`	`getSourcePrefixRangesList()` The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets.
`CidrRangeOrBuilder`	`getSourcePrefixRangesOrBuilder(int index)` The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets.
`List<? extends CidrRangeOrBuilder>`	`getSourcePrefixRangesOrBuilderList()` The criteria is satisfied if the source IP address of the downstream connection is contained in at least one of the specified subnets.
`FilterChainMatch.ConnectionSourceType`	`getSourceType()` Specifies the connection source IP match type.
`int`	`getSourceTypeValue()` Specifies the connection source IP match type.
`com.google.protobuf.UInt32Value`	`getSuffixLen()` [#not-implemented-hide:] `.google.protobuf.UInt32Value suffix_len = 5;`
`com.google.protobuf.UInt32ValueOrBuilder`	`getSuffixLenOrBuilder()` [#not-implemented-hide:] `.google.protobuf.UInt32Value suffix_len = 5;`
`String`	`getTransportProtocol()` If non-empty, a transport protocol to consider when determining a filter chain match.
`com.google.protobuf.ByteString`	`getTransportProtocolBytes()` If non-empty, a transport protocol to consider when determining a filter chain match.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDestinationPort()` Optional destination port to consider when use_original_dst is set on the listener in determining a filter chain match.
`int`	`hashCode()`
`boolean`	`hasSuffixLen()` [#not-implemented-hide:] `.google.protobuf.UInt32Value suffix_len = 5;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static FilterChainMatch.Builder`	`newBuilder()`
`static FilterChainMatch.Builder`	`newBuilder(FilterChainMatch prototype)`
`FilterChainMatch.Builder`	`newBuilderForType()`
`protected FilterChainMatch.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static FilterChainMatch`	`parseDelimitedFrom(InputStream input)`
`static FilterChainMatch`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static FilterChainMatch`	`parseFrom(byte[] data)`
`static FilterChainMatch`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static FilterChainMatch`	`parseFrom(ByteBuffer data)`
`static FilterChainMatch`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static FilterChainMatch`	`parseFrom(com.google.protobuf.ByteString data)`
`static FilterChainMatch`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static FilterChainMatch`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static FilterChainMatch`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static FilterChainMatch`	`parseFrom(InputStream input)`
`static FilterChainMatch`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<FilterChainMatch>`	`parser()`
`FilterChainMatch.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
- DESTINATION_PORT_FIELD_NUMBER
```
public static final int DESTINATION_PORT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PREFIX_RANGES_FIELD_NUMBER
```
public static final int PREFIX_RANGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ADDRESS_SUFFIX_FIELD_NUMBER
```
public static final int ADDRESS_SUFFIX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SUFFIX_LEN_FIELD_NUMBER
```
public static final int SUFFIX_LEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOURCE_TYPE_FIELD_NUMBER
```
public static final int SOURCE_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOURCE_PREFIX_RANGES_FIELD_NUMBER
```
public static final int SOURCE_PREFIX_RANGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOURCE_PORTS_FIELD_NUMBER
```
public static final int SOURCE_PORTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVER_NAMES_FIELD_NUMBER
```
public static final int SERVER_NAMES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSPORT_PROTOCOL_FIELD_NUMBER
```
public static final int TRANSPORT_PROTOCOL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- APPLICATION_PROTOCOLS_FIELD_NUMBER
```
public static final int APPLICATION_PROTOCOLS_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

hasDestinationPort
```
public boolean hasDestinationPort()
```
```
 Optional destination port to consider when use_original_dst is set on the
 listener in determining a filter chain match.
 
```
.google.protobuf.UInt32Value destination_port = 8 [(.validate.rules) = { ... }
Specified by:

hasDestinationPort in interface FilterChainMatchOrBuilder

getDestinationPort

public com.google.protobuf.UInt32Value getDestinationPort()

 Optional destination port to consider when use_original_dst is set on the
 listener in determining a filter chain match.

.google.protobuf.UInt32Value destination_port = 8 [(.validate.rules) = { ... }

Specified by:: getDestinationPort in interface FilterChainMatchOrBuilder

getDestinationPortOrBuilder

public com.google.protobuf.UInt32ValueOrBuilder getDestinationPortOrBuilder()

 Optional destination port to consider when use_original_dst is set on the
 listener in determining a filter chain match.

.google.protobuf.UInt32Value destination_port = 8 [(.validate.rules) = { ... }

Specified by:: getDestinationPortOrBuilder in interface FilterChainMatchOrBuilder

getPrefixRangesList

public List<CidrRange> getPrefixRangesList()

 If non-empty, an IP address and prefix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

repeated .envoy.config.core.v3.CidrRange prefix_ranges = 3;

Specified by:: getPrefixRangesList in interface FilterChainMatchOrBuilder

getPrefixRangesOrBuilderList

public List<? extends CidrRangeOrBuilder> getPrefixRangesOrBuilderList()

 If non-empty, an IP address and prefix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

repeated .envoy.config.core.v3.CidrRange prefix_ranges = 3;

Specified by:: getPrefixRangesOrBuilderList in interface FilterChainMatchOrBuilder

getPrefixRangesCount

public int getPrefixRangesCount()

 If non-empty, an IP address and prefix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

repeated .envoy.config.core.v3.CidrRange prefix_ranges = 3;

Specified by:: getPrefixRangesCount in interface FilterChainMatchOrBuilder

getPrefixRanges

public CidrRange getPrefixRanges(int index)

 If non-empty, an IP address and prefix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

repeated .envoy.config.core.v3.CidrRange prefix_ranges = 3;

Specified by:: getPrefixRanges in interface FilterChainMatchOrBuilder

getPrefixRangesOrBuilder

public CidrRangeOrBuilder getPrefixRangesOrBuilder(int index)

 If non-empty, an IP address and prefix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.

repeated .envoy.config.core.v3.CidrRange prefix_ranges = 3;

Specified by:: getPrefixRangesOrBuilder in interface FilterChainMatchOrBuilder

getAddressSuffix

public String getAddressSuffix()

 If non-empty, an IP address and suffix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
 [#not-implemented-hide:]

string address_suffix = 4;

Specified by:: getAddressSuffix in interface FilterChainMatchOrBuilder

getAddressSuffixBytes

public com.google.protobuf.ByteString getAddressSuffixBytes()

 If non-empty, an IP address and suffix length to match addresses when the
 listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
 [#not-implemented-hide:]

string address_suffix = 4;

Specified by:: getAddressSuffixBytes in interface FilterChainMatchOrBuilder

hasSuffixLen
```
public boolean hasSuffixLen()
```
```
 [#not-implemented-hide:]
 
```
.google.protobuf.UInt32Value suffix_len = 5;
Specified by:

hasSuffixLen in interface FilterChainMatchOrBuilder

getSuffixLen
```
public com.google.protobuf.UInt32Value getSuffixLen()
```
```
 [#not-implemented-hide:]
 
```
.google.protobuf.UInt32Value suffix_len = 5;
Specified by:

getSuffixLen in interface FilterChainMatchOrBuilder

getSuffixLenOrBuilder
```
public com.google.protobuf.UInt32ValueOrBuilder getSuffixLenOrBuilder()
```
```
 [#not-implemented-hide:]
 
```
.google.protobuf.UInt32Value suffix_len = 5;
Specified by:

getSuffixLenOrBuilder in interface FilterChainMatchOrBuilder

getSourceTypeValue
```
public int getSourceTypeValue()
```
```
 Specifies the connection source IP match type. Can be any, local or external network.
 
```
.envoy.config.listener.v3.FilterChainMatch.ConnectionSourceType source_type = 12 [(.validate.rules) = { ... }
Specified by:

getSourceTypeValue in interface FilterChainMatchOrBuilder

getSourceType
```
public FilterChainMatch.ConnectionSourceType getSourceType()
```
```
 Specifies the connection source IP match type. Can be any, local or external network.
 
```
.envoy.config.listener.v3.FilterChainMatch.ConnectionSourceType source_type = 12 [(.validate.rules) = { ... }
Specified by:

getSourceType in interface FilterChainMatchOrBuilder