java.lang.Object
- software.amazon.awssdk.services.networkfirewall.model.TCPFlagField

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TCPFlagField.Builder,TCPFlagField>
```
@Generated("software.amazon.awssdk:codegen")
public final class TCPFlagField
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TCPFlagField.Builder,TCPFlagField>
```
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TCPFlagField.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TCPFlagField.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<TCPFlag>`	`flags()`	Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match.
`List<String>`	`flagsAsStrings()`	Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFlags()`	For responses, this returns true if the service returned a value for the Flags property.
`int`	`hashCode()`
`boolean`	`hasMasks()`	For responses, this returns true if the service returned a value for the Masks property.
`List<TCPFlag>`	`masks()`	The set of flags to consider in the inspection.
`List<String>`	`masksAsStrings()`	The set of flags to consider in the inspection.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TCPFlagField.Builder>`	`serializableBuilderClass()`
`TCPFlagField.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
  - flags
```
public final List<TCPFlag> flags()
```
    Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
    
    For the flags that are specified in the masks setting, the following must be true for the packet to match:
    
    The ones that are set in this flags setting must be set in the packet.
    
    The ones that are not set in this flags setting must also not be set in the packet.
    
    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 hasFlags() method.
    Returns:
    
    Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
    
    For the flags that are specified in the masks setting, the following must be true for the packet to match:
    
    The ones that are set in this flags setting must be set in the packet.
    
    The ones that are not set in this flags setting must also not be set in the packet.
  - hasFlags
```
public final boolean hasFlags()
```
    For responses, this returns true if the service returned a value for the Flags 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.
  - flagsAsStrings
```
public final List<String> flagsAsStrings()
```
    Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
    
    For the flags that are specified in the masks setting, the following must be true for the packet to match:
    
    The ones that are set in this flags setting must be set in the packet.
    
    The ones that are not set in this flags setting must also not be set in the packet.
    
    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 hasFlags() method.
    Returns:
    
    Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
    
    For the flags that are specified in the masks setting, the following must be true for the packet to match:
    
    The ones that are set in this flags setting must be set in the packet.
    
    The ones that are not set in this flags setting must also not be set in the packet.
  - masks
```
public final List<TCPFlag> masks()
```
    The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
    
    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 hasMasks() method.
    
    Returns:
    
    The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
  - hasMasks
```
public final boolean hasMasks()
```
    For responses, this returns true if the service returned a value for the Masks 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.
  - masksAsStrings
```
public final List<String> masksAsStrings()
```
    The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
    
    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 hasMasks() method.
    
    Returns:
    
    The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
  - toBuilder
```
public TCPFlagField.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TCPFlagField.Builder,TCPFlagField>
  - builder
```
public static TCPFlagField.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TCPFlagField.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class TCPFlagField

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

flags

hasFlags

flagsAsStrings

masks

hasMasks

masksAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField