Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.waf.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:
- An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44
- A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.
To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getMetricName()` A friendly name or description for the metrics for this `Rule`.
`String`	`getName()` The friendly name or description for the `Rule`.
`List<Predicate>`	`getPredicates()` The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `Rule`.
`String`	`getRuleId()` A unique identifier for a `Rule`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMetricName(String metricName)` A friendly name or description for the metrics for this `Rule`.
`void`	`setName(String name)` The friendly name or description for the `Rule`.
`void`	`setPredicates(Collection<Predicate> predicates)` The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `Rule`.
`void`	`setRuleId(String ruleId)` A unique identifier for a `Rule`.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withMetricName(String metricName)` A friendly name or description for the metrics for this `Rule`.
`Rule`	`withName(String name)` The friendly name or description for the `Rule`.
`Rule`	`withPredicates(Collection<Predicate> predicates)` The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `Rule`.
`Rule`	`withPredicates(Predicate... predicates)` The `Predicates` object contains one `Predicate` element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a `Rule`.
`Rule`	`withRuleId(String ruleId)` A unique identifier for a `Rule`.

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

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setRuleId
```
public void setRuleId(String ruleId)
```
    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
    
    Parameters:
    
    ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
  - getRuleId
```
public String getRuleId()
```
    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
    
    Returns:
    
    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
  - withRuleId
```
public Rule withRuleId(String ruleId)
```
    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
    
    Parameters:
    
    ruleId - A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
    
    RuleId is returned by CreateRule and by ListRules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
    
    Parameters:
    
    name - The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
  - getName
```
public String getName()
```
    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
    
    Returns:
    
    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
  - withName
```
public Rule withName(String name)
```
    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
    
    Parameters:
    
    name - The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricName
```
public void setMetricName(String metricName)
```
    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
  - getMetricName
```
public String getMetricName()
```
    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
    
    Returns:
    
    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
  - withMetricName
```
public Rule withMetricName(String metricName)
```
    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPredicates
```
public List<Predicate> getPredicates()
```
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    Returns:
    
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
  - setPredicates
```
public void setPredicates(Collection<Predicate> predicates)
```
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    Parameters:
    
    predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
  - withPredicates
```
public Rule withPredicates(Predicate... predicates)
```
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setPredicates(java.util.Collection) or withPredicates(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPredicates
```
public Rule withPredicates(Collection<Predicate> predicates)
```
    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    Parameters:
    
    predicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
    
    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 Rule 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.

Did this page help you?

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setRuleId

getRuleId

withRuleId

setName

getName

withName

setMetricName

getMetricName

withMetricName

getPredicates

setPredicates

withPredicates

withPredicates

toString

equals

hashCode

clone

marshall