RuleGroupReferenceStatement (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wafv2.model.RuleGroupReferenceStatement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuleGroupReferenceStatement.Builder,RuleGroupReferenceStatement>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class RuleGroupReferenceStatement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleGroupReferenceStatement.Builder,RuleGroupReferenceStatement>
```
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RuleGroupReferenceStatement.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RuleGroupReferenceStatement.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the entity.
`static RuleGroupReferenceStatement.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExcludedRule>`	`excludedRules()` Rules in the referenced rule group whose actions are set to `Count`.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludedRules()` For responses, this returns true if the service returned a value for the ExcludedRules property.
`int`	`hashCode()`
`boolean`	`hasRuleActionOverrides()` For responses, this returns true if the service returned a value for the RuleActionOverrides property.
`List<RuleActionOverride>`	`ruleActionOverrides()` Action settings to use in the place of the rule actions that are configured inside the rule group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RuleGroupReferenceStatement.Builder>`	`serializableBuilderClass()`
`RuleGroupReferenceStatement.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
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - hasExcludedRules
```
public final boolean hasExcludedRules()
```
    For responses, this returns true if the service returned a value for the ExcludedRules 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.
  - excludedRules
```
public final List<ExcludedRule> excludedRules()
```
    Rules in the referenced rule group whose actions are set to Count.
    
    Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
    
    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 hasExcludedRules() method.
    
    Returns:
    
    Rules in the referenced rule group whose actions are set to Count.
    
    Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.
  - hasRuleActionOverrides
```
public final boolean hasRuleActionOverrides()
```
    For responses, this returns true if the service returned a value for the RuleActionOverrides 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.
  - ruleActionOverrides
```
public final List<RuleActionOverride> ruleActionOverrides()
```
    Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
    
    You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
    
    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 hasRuleActionOverrides() method.
    
    Returns:
    
    Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
    
    You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
  - toBuilder
```
public RuleGroupReferenceStatement.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RuleGroupReferenceStatement.Builder,RuleGroupReferenceStatement>
  - builder
```
public static RuleGroupReferenceStatement.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RuleGroupReferenceStatement.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

Class RuleGroupReferenceStatement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

hasExcludedRules

excludedRules

hasRuleActionOverrides

ruleActionOverrides

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields