software.amazon.awssdk.services.networkfirewall.model

Class MatchAttributes

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.MatchAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MatchAttributes.Builder,MatchAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class MatchAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MatchAttributes.Builder,MatchAttributes>

Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MatchAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static MatchAttributes.Builder	builder()
List<PortRange>	destinationPorts() The destination ports to inspect for.
List<Address>	destinations() The destination IP addresses and address ranges to inspect for, in CIDR notation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinationPorts() Returns true if the DestinationPorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDestinations() Returns true if the Destinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasProtocols() Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSourcePorts() Returns true if the SourcePorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSources() Returns true if the Sources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTcpFlags() Returns true if the TCPFlags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<Integer>	protocols() The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA).
List<SdkField<?>>	sdkFields()
static Class<? extends MatchAttributes.Builder>	serializableBuilderClass()
List<PortRange>	sourcePorts() The source ports to inspect for.
List<Address>	sources() The source IP addresses and address ranges to inspect for, in CIDR notation.
List<TCPFlagField>	tcpFlags() The TCP flags and masks to inspect for.
MatchAttributes.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSources

public final boolean hasSources()

Returns true if the Sources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sources

public final List<Address> sources()

The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSources() to see if a value was sent in this field.

Returns:

The source IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any source address.

hasDestinations

public final boolean hasDestinations()

Returns true if the Destinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

destinations

public final List<Address> destinations()

The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDestinations() to see if a value was sent in this field.

Returns:

The destination IP addresses and address ranges to inspect for, in CIDR notation. If not specified, this matches with any destination address.

hasSourcePorts

public final boolean hasSourcePorts()

Returns true if the SourcePorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sourcePorts

public final List<PortRange> sourcePorts()

The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990-1994.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSourcePorts() to see if a value was sent in this field.

Returns:

The source ports to inspect for. If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990-1994.

hasDestinationPorts

public final boolean hasDestinationPorts()

Returns true if the DestinationPorts property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

destinationPorts

public final List<PortRange> destinationPorts()

The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990-1994.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDestinationPorts() to see if a value was sent in this field.

Returns:

The destination ports to inspect for. If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).

You can specify individual ports, for example 1994 and you can specify port ranges, for example 1990-1994.

hasProtocols

public final boolean hasProtocols()

Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

protocols

public final List<Integer> protocols()

The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasProtocols() to see if a value was sent in this field.

Returns:

The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). If not specified, this matches with any protocol.

hasTcpFlags

public final boolean hasTcpFlags()

Returns true if the TCPFlags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tcpFlags

public final List<TCPFlagField> tcpFlags()

The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTcpFlags() to see if a value was sent in this field.

Returns:

The TCP flags and masks to inspect for. If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP).

toBuilder

public MatchAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MatchAttributes.Builder,MatchAttributes>

builder

public static MatchAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends MatchAttributes.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo