Package software.amazon.awssdk.services.networkfirewall.model

Class RuleOption

java.lang.Object

software.amazon.awssdk.services.networkfirewall.model.RuleOption

All Implemented Interfaces:

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

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

Additional settings for a stateful rule. This is part of the StatefulRule configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleOption.Builder

Method Summary

Modifier and Type	Method	Description
static RuleOption.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSettings()	For responses, this returns true if the service returned a value for the Settings property.
String	keyword()	The keyword for the Suricata compatible rule option.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RuleOption.Builder>	serializableBuilderClass()
List<String>	settings()	The settings of the Suricata compatible rule option.
RuleOption.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

keyword

public final String keyword()

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

Returns:

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

hasSettings

public final boolean hasSettings()

For responses, this returns true if the service returned a value for the Settings 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.

settings

public final List<String> settings()

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.

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 hasSettings() method.

Returns:

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.

toBuilder

public RuleOption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleOption.Builder,RuleOption>

builder

public static RuleOption.Builder builder()

serializableBuilderClass

public static Class<? extends RuleOption.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