RuleAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.RuleAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleAction()

Constructors
Constructor and Description
`RuleAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleAction`	`clone()`
`boolean`	`equals(Object obj)`
`AllowAction`	`getAllow()` Instructs WAF to allow the web request.
`BlockAction`	`getBlock()` Instructs WAF to block the web request.
`CaptchaAction`	`getCaptcha()` Instructs WAF to run a `CAPTCHA` check against the web request.
`ChallengeAction`	`getChallenge()` Instructs WAF to run a `Challenge` check against the web request.
`CountAction`	`getCount()` Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllow(AllowAction allow)` Instructs WAF to allow the web request.
`void`	`setBlock(BlockAction block)` Instructs WAF to block the web request.
`void`	`setCaptcha(CaptchaAction captcha)` Instructs WAF to run a `CAPTCHA` check against the web request.
`void`	`setChallenge(ChallengeAction challenge)` Instructs WAF to run a `Challenge` check against the web request.
`void`	`setCount(CountAction count)` Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
`String`	`toString()` Returns a string representation of this object.
`RuleAction`	`withAllow(AllowAction allow)` Instructs WAF to allow the web request.
`RuleAction`	`withBlock(BlockAction block)` Instructs WAF to block the web request.
`RuleAction`	`withCaptcha(CaptchaAction captcha)` Instructs WAF to run a `CAPTCHA` check against the web request.
`RuleAction`	`withChallenge(ChallengeAction challenge)` Instructs WAF to run a `Challenge` check against the web request.
`RuleAction`	`withCount(CountAction count)` Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RuleAction
```
public RuleAction()
```
- Method Detail
  - setBlock
```
public void setBlock(BlockAction block)
```
    Instructs WAF to block the web request.
    
    Parameters:
    
    block - Instructs WAF to block the web request.
  - getBlock
```
public BlockAction getBlock()
```
    Instructs WAF to block the web request.
    
    Returns:
    
    Instructs WAF to block the web request.
  - withBlock
```
public RuleAction withBlock(BlockAction block)
```
    Instructs WAF to block the web request.
    
    Parameters:
    
    block - Instructs WAF to block the web request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllow
```
public void setAllow(AllowAction allow)
```
    Instructs WAF to allow the web request.
    
    Parameters:
    
    allow - Instructs WAF to allow the web request.
  - getAllow
```
public AllowAction getAllow()
```
    Instructs WAF to allow the web request.
    
    Returns:
    
    Instructs WAF to allow the web request.
  - withAllow
```
public RuleAction withAllow(AllowAction allow)
```
    Instructs WAF to allow the web request.
    
    Parameters:
    
    allow - Instructs WAF to allow the web request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCount
```
public void setCount(CountAction count)
```
    Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
    
    Parameters:
    
    count - Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
  - getCount
```
public CountAction getCount()
```
    Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
    
    Returns:
    
    Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
  - withCount
```
public RuleAction withCount(CountAction count)
```
    Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
    
    Parameters:
    
    count - Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCaptcha
```
public void setCaptcha(CaptchaAction captcha)
```
    Instructs WAF to run a CAPTCHA check against the web request.
    
    Parameters:
    
    captcha - Instructs WAF to run a CAPTCHA check against the web request.
  - getCaptcha
```
public CaptchaAction getCaptcha()
```
    Instructs WAF to run a CAPTCHA check against the web request.
    
    Returns:
    
    Instructs WAF to run a CAPTCHA check against the web request.
  - withCaptcha
```
public RuleAction withCaptcha(CaptchaAction captcha)
```
    Instructs WAF to run a CAPTCHA check against the web request.
    
    Parameters:
    
    captcha - Instructs WAF to run a CAPTCHA check against the web request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChallenge
```
public void setChallenge(ChallengeAction challenge)
```
    Instructs WAF to run a Challenge check against the web request.
    
    Parameters:
    
    challenge - Instructs WAF to run a Challenge check against the web request.
  - getChallenge
```
public ChallengeAction getChallenge()
```
    Instructs WAF to run a Challenge check against the web request.
    
    Returns:
    
    Instructs WAF to run a Challenge check against the web request.
  - withChallenge
```
public RuleAction withChallenge(ChallengeAction challenge)
```
    Instructs WAF to run a Challenge check against the web request.
    
    Parameters:
    
    challenge - Instructs WAF to run a Challenge check against the web request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RuleAction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class RuleAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleAction

Method Detail

setBlock

getBlock

withBlock

setAllow

getAllow

withAllow

setCount

getCount

withCount

setCaptcha

getCaptcha

withCaptcha

setChallenge

getChallenge

withChallenge

toString

equals

hashCode

clone

marshall