RuleGroup (AWS Java SDK for AWS WAF 1.12.262 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroup
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 collection of predefined rules that you can add to a web ACL.

Rule groups are subject to the following limits:
- Three rule groups per account. You can request an increase to this limit by contacting customer support.
- One rule group per web ACL.
- Ten rules per rule group.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroup()

Constructors
Constructor and Description
`RuleGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getMetricName()` A friendly name or description for the metrics for this `RuleGroup`.
`String`	`getName()` The friendly name or description for the `RuleGroup`.
`String`	`getRuleGroupId()` A unique identifier for a `RuleGroup`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setMetricName(String metricName)` A friendly name or description for the metrics for this `RuleGroup`.
`void`	`setName(String name)` The friendly name or description for the `RuleGroup`.
`void`	`setRuleGroupId(String ruleGroupId)` A unique identifier for a `RuleGroup`.
`String`	`toString()` Returns a string representation of this object.
`RuleGroup`	`withMetricName(String metricName)` A friendly name or description for the metrics for this `RuleGroup`.
`RuleGroup`	`withName(String name)` The friendly name or description for the `RuleGroup`.
`RuleGroup`	`withRuleGroupId(String ruleGroupId)` A unique identifier for a `RuleGroup`.

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

- Constructor Detail
  - RuleGroup
```
public RuleGroup()
```
- Method Detail
  - setRuleGroupId
```
public void setRuleGroupId(String ruleGroupId)
```
    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
    
    Parameters:
    
    ruleGroupId - A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
  - getRuleGroupId
```
public String getRuleGroupId()
```
    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
    
    Returns:
    
    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
  - withRuleGroupId
```
public RuleGroup withRuleGroupId(String ruleGroupId)
```
    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
    
    Parameters:
    
    ruleGroupId - A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
    
    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
    
    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 RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Parameters:
    
    name - The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
  - getName
```
public String getName()
```
    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Returns:
    
    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
  - withName
```
public RuleGroup withName(String name)
```
    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
    
    Parameters:
    
    name - The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup 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 RuleGroup. 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 the name of the metric after you create the RuleGroup.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
  - getMetricName
```
public String getMetricName()
```
    A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
    
    Returns:
    
    A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
  - withMetricName
```
public RuleGroup withMetricName(String metricName)
```
    A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
    
    Parameters:
    
    metricName - A friendly name or description for the metrics for this RuleGroup. 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 the name of the metric after you create the RuleGroup.
    
    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 RuleGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class RuleGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroup

Method Detail

setRuleGroupId

getRuleGroupId

withRuleGroupId

setName

getName

withName

setMetricName

getMetricName

withMetricName

toString

equals

hashCode

clone

marshall