Package software.amazon.awssdk.services.securityhub.model

Class AwsWafRuleGroupDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafRuleGroupDetails

All Implemented Interfaces:

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

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

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsWafRuleGroupDetails.Builder

Method Summary

Modifier and Type	Method	Description
static AwsWafRuleGroupDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
String	metricName()	The name of the metrics for this rule group.
String	name()	The name of the rule group.
String	ruleGroupId()	The ID of the rule group.
List<AwsWafRuleGroupRulesDetails>	rules()	Provides information about the rules attached to the rule group.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafRuleGroupDetails.Builder>	serializableBuilderClass()
AwsWafRuleGroupDetails.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

metricName

public final String metricName()

The name of the metrics for this rule group.

Returns:

The name of the metrics for this rule group.

name

public final String name()

The name of the rule group.

Returns:

The name of the rule group.

ruleGroupId

public final String ruleGroupId()

The ID of the rule group.

Returns:

The ID of the rule group.

hasRules

public final boolean hasRules()

For responses, this returns true if the service returned a value for the Rules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

rules

public final List<AwsWafRuleGroupRulesDetails> rules()

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to allow, block, or count.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRules() method.

Returns:

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to allow, block, or count.

toBuilder

public AwsWafRuleGroupDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafRuleGroupDetails.Builder,AwsWafRuleGroupDetails>

builder

public static AwsWafRuleGroupDetails.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo