software.amazon.awssdk.services.wafv2.model

Class VisibilityConfig

java.lang.Object

software.amazon.awssdk.services.wafv2.model.VisibilityConfig

All Implemented Interfaces:

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

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

Defines and enables Amazon CloudWatch metrics and web request sample collection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VisibilityConfig.Builder

Method Summary

Modifier and Type	Method and Description
static VisibilityConfig.Builder	builder()
Boolean	cloudWatchMetricsEnabled() A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metricName() A name of the Amazon CloudWatch metric.
Boolean	sampledRequestsEnabled() A boolean indicating whether WAF should store a sampling of the web requests that match the rules.
List<SdkField<?>>	sdkFields()
static Class<? extends VisibilityConfig.Builder>	serializableBuilderClass()
VisibilityConfig.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

sampledRequestsEnabled

public final Boolean sampledRequestsEnabled()

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

Returns:

A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.

cloudWatchMetricsEnabled

public final Boolean cloudWatchMetricsEnabled()

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

Returns:

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

metricName

public final String metricName()

A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action.

Returns:

A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example All and Default_Action .

toBuilder

public VisibilityConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VisibilityConfig.Builder,VisibilityConfig>

builder

public static VisibilityConfig.Builder builder()

serializableBuilderClass

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