Package software.amazon.awssdk.services.wafv2.model

Class RuleGroupSummary

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RuleGroupSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RuleGroupSummary.Builder,RuleGroupSummary>

@Generated("software.amazon.awssdk:codegen")
public final class RuleGroupSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RuleGroupSummary.Builder,RuleGroupSummary>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleGroupSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the entity.
static RuleGroupSummary.Builder	builder()
String	description()	A description of the rule group that helps with identification.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A unique identifier for the rule group.
String	lockToken()	A token used for optimistic locking.
String	name()	The name of the data type instance.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleGroupSummary.Builder>	serializableBuilderClass()
RuleGroupSummary.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

name

public final String name()

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.

id

public final 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.

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.

description

public final String description()

A description of the rule group that helps with identification.

Returns:

A description of the rule group that helps with identification.

lockToken

public final String lockToken()

A token used for optimistic locking. 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. 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. 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. 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.

arn

public final String arn()

The Amazon Resource Name (ARN) of the entity.

Returns:

The Amazon Resource Name (ARN) of the entity.

toBuilder

public RuleGroupSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleGroupSummary.Builder,RuleGroupSummary>

builder

public static RuleGroupSummary.Builder builder()

serializableBuilderClass

public static Class<? extends RuleGroupSummary.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