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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RulesSource.Builder,RulesSource>
```
@Generated("software.amazon.awssdk:codegen")
public final class RulesSource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RulesSource.Builder,RulesSource>
```
The stateless or stateful rules definitions for use in a single rule group. Each rule group requires a single RulesSource. You can use an instance of this for either stateless rules or stateful rules.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RulesSource.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RulesSource.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStatefulRules()`	For responses, this returns true if the service returned a value for the StatefulRules property.
`RulesSourceList`	`rulesSourceList()`	Stateful inspection criteria for a domain list rule group.
`String`	`rulesString()`	Stateful inspection criteria, provided in Suricata compatible rules.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RulesSource.Builder>`	`serializableBuilderClass()`
`List<StatefulRule>`	`statefulRules()`	An array of individual stateful rules inspection criteria to be used together in a stateful rule group.
`StatelessRulesAndCustomActions`	`statelessRulesAndCustomActions()`	Stateless inspection criteria to be used in a stateless rule group.
`RulesSource.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
  - rulesString
```
public final String rulesString()
```
    Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
    
    These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
    
    You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.
    
    Returns:
    
    Stateful inspection criteria, provided in Suricata compatible rules. Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection.
    
    These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.
    
    You can't use the priority keyword if the RuleOrder option in StatefulRuleOptions is set to STRICT_ORDER.
  - rulesSourceList
```
public final RulesSourceList rulesSourceList()
```
    Stateful inspection criteria for a domain list rule group.
    
    Returns:
    
    Stateful inspection criteria for a domain list rule group.
  - hasStatefulRules
```
public final boolean hasStatefulRules()
```
    For responses, this returns true if the service returned a value for the StatefulRules 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.
  - statefulRules
```
public final List<StatefulRule> statefulRules()
```
    An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
    
    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 hasStatefulRules() method.
    
    Returns:
    
    An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata Rules format, see Rules Format.
  - statelessRulesAndCustomActions
```
public final StatelessRulesAndCustomActions statelessRulesAndCustomActions()
```
    Stateless inspection criteria to be used in a stateless rule group.
    
    Returns:
    
    Stateless inspection criteria to be used in a stateless rule group.
  - toBuilder
```
public RulesSource.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RulesSource.Builder,RulesSource>
  - builder
```
public static RulesSource.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RulesSource.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 RulesSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

rulesString

rulesSourceList

hasStatefulRules

statefulRules

statelessRulesAndCustomActions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField