VisibilityConfig (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.VisibilityConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VisibilityConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VisibilityConfig()

Constructors
Constructor and Description
`VisibilityConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VisibilityConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCloudWatchMetricsEnabled()` A boolean indicating whether the associated resource sends metrics to CloudWatch.
`String`	`getMetricName()` A name of the CloudWatch metric.
`Boolean`	`getSampledRequestsEnabled()` A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.
`int`	`hashCode()`
`Boolean`	`isCloudWatchMetricsEnabled()` A boolean indicating whether the associated resource sends metrics to CloudWatch.
`Boolean`	`isSampledRequestsEnabled()` A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)` A boolean indicating whether the associated resource sends metrics to CloudWatch.
`void`	`setMetricName(String metricName)` A name of the CloudWatch metric.
`void`	`setSampledRequestsEnabled(Boolean sampledRequestsEnabled)` A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.
`String`	`toString()` Returns a string representation of this object.
`VisibilityConfig`	`withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)` A boolean indicating whether the associated resource sends metrics to CloudWatch.
`VisibilityConfig`	`withMetricName(String metricName)` A name of the CloudWatch metric.
`VisibilityConfig`	`withSampledRequestsEnabled(Boolean sampledRequestsEnabled)` A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VisibilityConfig
```
public VisibilityConfig()
```
- Method Detail
  - setSampledRequestsEnabled
```
public void setSampledRequestsEnabled(Boolean sampledRequestsEnabled)
```
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
    
    Parameters:
    
    sampledRequestsEnabled - A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
  - getSampledRequestsEnabled
```
public Boolean getSampledRequestsEnabled()
```
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
    
    Returns:
    
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
  - withSampledRequestsEnabled
```
public VisibilityConfig withSampledRequestsEnabled(Boolean sampledRequestsEnabled)
```
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
    
    Parameters:
    
    sampledRequestsEnabled - A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSampledRequestsEnabled
```
public Boolean isSampledRequestsEnabled()
```
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
    
    Returns:
    
    A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
  - setCloudWatchMetricsEnabled
```
public void setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
    
    Parameters:
    
    cloudWatchMetricsEnabled - A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
  - getCloudWatchMetricsEnabled
```
public Boolean getCloudWatchMetricsEnabled()
```
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
    
    Returns:
    
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
  - withCloudWatchMetricsEnabled
```
public VisibilityConfig withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
    
    Parameters:
    
    cloudWatchMetricsEnabled - A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCloudWatchMetricsEnabled
```
public Boolean isCloudWatchMetricsEnabled()
```
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
    
    Returns:
    
    A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
  - setMetricName
```
public void setMetricName(String metricName)
```
    A name of the 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 AWS WAF, for example "All" and "Default_Action."
    
    Parameters:
    
    metricName - A name of the 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 AWS WAF, for example "All" and "Default_Action."
  - getMetricName
```
public String getMetricName()
```
    A name of the 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 AWS WAF, for example "All" and "Default_Action."
    
    Returns:
    
    A name of the 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 AWS WAF, for example "All" and "Default_Action."
  - withMetricName
```
public VisibilityConfig withMetricName(String metricName)
```
    A name of the 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 AWS WAF, for example "All" and "Default_Action."
    
    Parameters:
    
    metricName - A name of the 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 AWS WAF, for example "All" and "Default_Action."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VisibilityConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class VisibilityConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VisibilityConfig

Method Detail

setSampledRequestsEnabled

getSampledRequestsEnabled

withSampledRequestsEnabled

isSampledRequestsEnabled

setCloudWatchMetricsEnabled

getCloudWatchMetricsEnabled

withCloudWatchMetricsEnabled

isCloudWatchMetricsEnabled

setMetricName

getMetricName

withMetricName

toString

equals

hashCode

clone

marshall