software.amazon.awssdk.services.waf.model

Class RuleSummary

java.lang.Object

software.amazon.awssdk.services.waf.model.RuleSummary

All Implemented Interfaces:

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

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

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.

Contains the identifier and the friendly name or description of the Rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuleSummary.Builder

Method Summary

Modifier and Type	Method and Description
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() A friendly name or description of the Rule.
String	ruleId() A unique identifier for a 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

ruleId

public final 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 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 one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

name

public final String name()

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Returns:

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

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