RuleGroupSummary (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroupSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RuleGroupSummary()

Constructors
Constructor and Description
`RuleGroupSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuleGroupSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The Amazon Resource Name (ARN) of the entity.
`String`	`getDescription()` A description of the rule group that helps with identification.
`String`	`getId()` A unique identifier for the rule group.
`String`	`getLockToken()` A token used for optimistic locking.
`String`	`getName()` The name of the data type instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`void`	`setDescription(String description)` A description of the rule group that helps with identification.
`void`	`setId(String id)` A unique identifier for the rule group.
`void`	`setLockToken(String lockToken)` A token used for optimistic locking.
`void`	`setName(String name)` The name of the data type instance.
`String`	`toString()` Returns a string representation of this object.
`RuleGroupSummary`	`withARN(String aRN)` The Amazon Resource Name (ARN) of the entity.
`RuleGroupSummary`	`withDescription(String description)` A description of the rule group that helps with identification.
`RuleGroupSummary`	`withId(String id)` A unique identifier for the rule group.
`RuleGroupSummary`	`withLockToken(String lockToken)` A token used for optimistic locking.
`RuleGroupSummary`	`withName(String name)` The name of the data type instance.

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

- Constructor Detail
  - RuleGroupSummary
```
public RuleGroupSummary()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the data type instance. You cannot change the name after you create the instance.
    
    Parameters:
    
    name - The name of the data type instance. You cannot change the name after you create the instance.
  - getName
```
public String getName()
```
    The name of the data type instance. You cannot change the name after you create the instance.
    
    Returns:
    
    The name of the data type instance. You cannot change the name after you create the instance.
  - withName
```
public RuleGroupSummary withName(String name)
```
    The name of the data type instance. You cannot change the name after you create the instance.
    
    Parameters:
    
    name - The name of the data type instance. You cannot change the name after you create the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - getId
```
public String getId()
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - withId
```
public RuleGroupSummary withId(String id)
```
    A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Parameters:
    
    id - A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
    
    Parameters:
    
    description - A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
  - getDescription
```
public String getDescription()
```
    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
    
    Returns:
    
    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
  - withDescription
```
public RuleGroupSummary withDescription(String description)
```
    A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
    
    Parameters:
    
    description - A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLockToken
```
public void setLockToken(String lockToken)
```
    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
    
    Parameters:
    
    lockToken - A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
  - getLockToken
```
public String getLockToken()
```
    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
    
    Returns:
    
    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
  - withLockToken
```
public RuleGroupSummary withLockToken(String lockToken)
```
    A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
    
    Parameters:
    
    lockToken - A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setARN
```
public void setARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
  - getARN
```
public String getARN()
```
    The Amazon Resource Name (ARN) of the entity.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the entity.
  - withARN
```
public RuleGroupSummary withARN(String aRN)
```
    The Amazon Resource Name (ARN) of the entity.
    
    Parameters:
    
    aRN - The Amazon Resource Name (ARN) of the entity.
    
    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 RuleGroupSummary 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 RuleGroupSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RuleGroupSummary

Method Detail

setName

getName

withName

setId

getId

withId

setDescription

getDescription

withDescription

setLockToken

getLockToken

withLockToken

setARN

getARN

withARN

toString

equals

hashCode

clone

marshall