Class TCPFlagField
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TCPFlagField.Builder,
TCPFlagField>
TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TCPFlagField.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.flags()
Used in conjunction with theMasks
setting to define the flags that must be set and flags that must not be set in order for the packet to match.Used in conjunction with theMasks
setting to define the flags that must be set and flags that must not be set in order for the packet to match.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasFlags()
For responses, this returns true if the service returned a value for the Flags property.final int
hashCode()
final boolean
hasMasks()
For responses, this returns true if the service returned a value for the Masks property.masks()
The set of flags to consider in the inspection.The set of flags to consider in the inspection.static Class
<? extends TCPFlagField.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theMasks
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 theMasks
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 theisEmpty()
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
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 theMasks
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 theMasks
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TCPFlagField.Builder,
TCPFlagField> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-