/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class VisibilityConfig implements Serializable, Cloneable, StructuredPojo { /** *

* 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. *

*/ private Boolean sampledRequestsEnabled; /** *

* 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. *

*/ private Boolean cloudWatchMetricsEnabled; /** *

* 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. *

*/ private String metricName; /** *

* 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. *

* * @param 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. */ public void setSampledRequestsEnabled(Boolean sampledRequestsEnabled) { this.sampledRequestsEnabled = 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. *

* * @return 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. */ public Boolean getSampledRequestsEnabled() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public VisibilityConfig withSampledRequestsEnabled(Boolean sampledRequestsEnabled) { setSampledRequestsEnabled(sampledRequestsEnabled); return this; } /** *

* 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. *

* * @return 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. */ public Boolean isSampledRequestsEnabled() { return this.sampledRequestsEnabled; } /** *

* Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, * see WAF * Metrics in the WAF Developer Guide. *

* * @param 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. */ public void setCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled) { this.cloudWatchMetricsEnabled = 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. *

* * @return 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. */ public Boolean getCloudWatchMetricsEnabled() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public VisibilityConfig withCloudWatchMetricsEnabled(Boolean cloudWatchMetricsEnabled) { setCloudWatchMetricsEnabled(cloudWatchMetricsEnabled); return this; } /** *

* Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, * see WAF * Metrics in the WAF Developer Guide. *

* * @return 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. */ public Boolean isCloudWatchMetricsEnabled() { return this.cloudWatchMetricsEnabled; } /** *

* * @return 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. */ public String getMetricName() { return this.metricName; } /** *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public VisibilityConfig withMetricName(String metricName) { setMetricName(metricName); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getSampledRequestsEnabled() != null) sb.append("SampledRequestsEnabled: ").append(getSampledRequestsEnabled()).append(","); if (getCloudWatchMetricsEnabled() != null) sb.append("CloudWatchMetricsEnabled: ").append(getCloudWatchMetricsEnabled()).append(","); if (getMetricName() != null) sb.append("MetricName: ").append(getMetricName()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof VisibilityConfig == false) return false; VisibilityConfig other = (VisibilityConfig) obj; if (other.getSampledRequestsEnabled() == null ^ this.getSampledRequestsEnabled() == null) return false; if (other.getSampledRequestsEnabled() != null && other.getSampledRequestsEnabled().equals(this.getSampledRequestsEnabled()) == false) return false; if (other.getCloudWatchMetricsEnabled() == null ^ this.getCloudWatchMetricsEnabled() == null) return false; if (other.getCloudWatchMetricsEnabled() != null && other.getCloudWatchMetricsEnabled().equals(this.getCloudWatchMetricsEnabled()) == false) return false; if (other.getMetricName() == null ^ this.getMetricName() == null) return false; if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getSampledRequestsEnabled() == null) ? 0 : getSampledRequestsEnabled().hashCode()); hashCode = prime * hashCode + ((getCloudWatchMetricsEnabled() == null) ? 0 : getCloudWatchMetricsEnabled().hashCode()); hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode()); return hashCode; } @Override public VisibilityConfig clone() { try { return (VisibilityConfig) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.wafv2.model.transform.VisibilityConfigMarshaller.getInstance().marshall(this, protocolMarshaller); } }