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
```
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()` Indicates whether the associated resource sends metrics to Amazon CloudWatch.
`String`	`getMetricName()` A name of the Amazon CloudWatch metric dimension.
`Boolean`	`getSampledRequestsEnabled()` Indicates whether WAF should store a sampling of the web requests that match the rules.
`int`	`hashCode()`
`Boolean`	`isCloudWatchMetricsEnabled()` Indicates whether the associated resource sends metrics to Amazon CloudWatch.
`Boolean`	`isSampledRequestsEnabled()` Indicates whether 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)` Indicates whether the associated resource sends metrics to Amazon CloudWatch.
`void`	`setMetricName(String metricName)` A name of the Amazon CloudWatch metric dimension.
`void`	`setSampledRequestsEnabled(Boolean sampledRequestsEnabled)` Indicates whether 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)` Indicates whether the associated resource sends metrics to Amazon CloudWatch.
`VisibilityConfig`	`withMetricName(String metricName)` A name of the Amazon CloudWatch metric dimension.
`VisibilityConfig`	`withSampledRequestsEnabled(Boolean sampledRequestsEnabled)` Indicates whether 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)
```
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
    
    Parameters:
    
    sampledRequestsEnabled - Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
  - getSampledRequestsEnabled
```
public Boolean getSampledRequestsEnabled()
```
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
    
    Returns:
    
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
  - withSampledRequestsEnabled
```
public VisibilityConfig withSampledRequestsEnabled(Boolean sampledRequestsEnabled)
```
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
    
    Parameters:
    
    sampledRequestsEnabled - Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSampledRequestsEnabled
```
public Boolean isSampledRequestsEnabled()
```
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
    
    Returns:
    
    Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
    
    Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
  - setCloudWatchMetricsEnabled
```
public void setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
    
    Parameters:
    
    cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
  - getCloudWatchMetricsEnabled
```
public Boolean getCloudWatchMetricsEnabled()
```
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
    
    Returns:
    
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
  - withCloudWatchMetricsEnabled
```
public VisibilityConfig withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled)
```
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
    
    Parameters:
    
    cloudWatchMetricsEnabled - Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCloudWatchMetricsEnabled
```
public Boolean isCloudWatchMetricsEnabled()
```
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
    
    Returns:
    
    Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
    
    For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
  - setMetricName
```
public void setMetricName(String metricName)
```
    A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example All and Default_Action.
    
    Parameters:
    
    metricName - A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example All and Default_Action.
  - getMetricName
```
public String getMetricName()
```
    A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example All and Default_Action.
    
    Returns:
    
    A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example All and Default_Action.
  - withMetricName
```
public VisibilityConfig withMetricName(String metricName)
```
    A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example All and Default_Action.
    
    Parameters:
    
    metricName - A name of the Amazon CloudWatch metric dimension. 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 that are reserved for 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.

AWS SDK for Java 1.x API Reference - 1.12.773

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