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

Class RuleSummary

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RuleSummary

All Implemented Interfaces:

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

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

High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. 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	RuleSummary.Builder

Method Summary

Modifier and Type	Method	Description
RuleAction	action()	The action that WAF should take on a web request when it matches a rule's statement.
static RuleSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the rule.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleSummary.Builder>	serializableBuilderClass()
RuleSummary.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 rule.

Returns:

The name of the rule.

action

public final RuleAction action()

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.

Returns:

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.

toBuilder

public RuleSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleSummary.Builder,RuleSummary>

builder

public static RuleSummary.Builder builder()

serializableBuilderClass

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