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() For responses, this returns true if the service returned a value for the DestinationPorts property.
boolean	hasDestinations() For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
boolean	hasProtocols() For responses, this returns true if the service returned a value for the Protocols property.
boolean	hasSourcePorts() For responses, this returns true if the service returned a value for the SourcePorts property.
boolean	hasSources() For responses, this returns true if the service returned a value for the Sources property.
boolean	hasTcpFlags() For responses, this returns true if the service returned a value for the TCPFlags property.
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()

For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSources() method.

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()

For responses, this returns true if the service returned a value for the Destinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinations() method.

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()

For responses, this returns true if the service returned a value for the SourcePorts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourcePorts() method.

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()

For responses, this returns true if the service returned a value for the DestinationPorts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationPorts() method.

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()

For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.

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()

For responses, this returns true if the service returned a value for the TCPFlags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTcpFlags() method.

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