/* * 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.waf.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** * *

* This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the * developer guide. *

*

* For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the * latest version, AWS WAF has a single set of endpoints for regional and global use. *

* *

* A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web * requests that you want to allow, block, or count. For example, you might create a Rule that includes the * following predicates: *

* *

* To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a * User-Agent header for which the value is BadBot. *

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

* A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). *

*

* RuleId is returned by CreateRule and by ListRules. *

*/ private String ruleId; /** *

* The friendly name or description for the Rule. You can't change the name of a Rule * after you create it. *

*/ private String name; /** *

* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric * characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric * names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after * you create the Rule. *

*/ private String metricName; /** *

* The Predicates object contains one Predicate element for each ByteMatchSet, * IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. *

*/ private java.util.List predicates; /** *

* A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). *

*

* RuleId is returned by CreateRule and by ListRules. *

* * @param ruleId * A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

*

* RuleId is returned by CreateRule and by ListRules. */ public void setRuleId(String ruleId) { this.ruleId = ruleId; } /** *

* A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). *

*

* RuleId is returned by CreateRule and by ListRules. *

* * @return A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

*

* RuleId is returned by CreateRule and by ListRules. */ public String getRuleId() { return this.ruleId; } /** *

* A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). *

*

* RuleId is returned by CreateRule and by ListRules. *

* * @param ruleId * A unique identifier for a Rule. You use RuleId to get more information about a * Rule (see GetRule), update a Rule (see UpdateRule), insert a * Rule into a WebACL or delete a one from a WebACL (see * UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

*

* RuleId is returned by CreateRule and by ListRules. * @return Returns a reference to this object so that method calls can be chained together. */ public Rule withRuleId(String ruleId) { setRuleId(ruleId); return this; } /** *

* The friendly name or description for the Rule. You can't change the name of a Rule * after you create it. *

* * @param name * The friendly name or description for the Rule. You can't change the name of a * Rule after you create it. */ public void setName(String name) { this.name = name; } /** *

* The friendly name or description for the Rule. You can't change the name of a Rule * after you create it. *

* * @return The friendly name or description for the Rule. You can't change the name of a * Rule after you create it. */ public String getName() { return this.name; } /** *

* The friendly name or description for the Rule. You can't change the name of a Rule * after you create it. *

* * @param name * The friendly name or description for the Rule. You can't change the name of a * Rule after you create it. * @return Returns a reference to this object so that method calls can be chained together. */ public Rule withName(String name) { setName(name); return this; } /** *

* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric * characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric * names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after * you create the Rule. *

* * @param metricName * A friendly name or description for the metrics for this Rule. The name can contain only * alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain * whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change * MetricName after you create the Rule. */ public void setMetricName(String metricName) { this.metricName = metricName; } /** *

* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric * characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric * names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after * you create the Rule. *

* * @return A friendly name or description for the metrics for this Rule. The name can contain only * alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain * whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change * MetricName after you create the Rule. */ public String getMetricName() { return this.metricName; } /** *

* A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric * characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric * names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after * you create the Rule. *

* * @param metricName * A friendly name or description for the metrics for this Rule. The name can contain only * alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain * whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change * MetricName after you create the Rule. * @return Returns a reference to this object so that method calls can be chained together. */ public Rule withMetricName(String metricName) { setMetricName(metricName); return this; } /** *

* The Predicates object contains one Predicate element for each ByteMatchSet, * IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. *

* * @return The Predicates object contains one Predicate element for each * ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a * Rule. */ public java.util.List getPredicates() { return predicates; } /** *

* The Predicates object contains one Predicate element for each ByteMatchSet, * IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. *

* * @param predicates * The Predicates object contains one Predicate element for each * ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a * Rule. */ public void setPredicates(java.util.Collection predicates) { if (predicates == null) { this.predicates = null; return; } this.predicates = new java.util.ArrayList(predicates); } /** *

* The Predicates object contains one Predicate element for each ByteMatchSet, * IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPredicates(java.util.Collection)} or {@link #withPredicates(java.util.Collection)} if you want to * override the existing values. *

* * @param predicates * The Predicates object contains one Predicate element for each * ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a * Rule. * @return Returns a reference to this object so that method calls can be chained together. */ public Rule withPredicates(Predicate... predicates) { if (this.predicates == null) { setPredicates(new java.util.ArrayList(predicates.length)); } for (Predicate ele : predicates) { this.predicates.add(ele); } return this; } /** *

* The Predicates object contains one Predicate element for each ByteMatchSet, * IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. *

* * @param predicates * The Predicates object contains one Predicate element for each * ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a * Rule. * @return Returns a reference to this object so that method calls can be chained together. */ public Rule withPredicates(java.util.Collection predicates) { setPredicates(predicates); 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 (getRuleId() != null) sb.append("RuleId: ").append(getRuleId()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getMetricName() != null) sb.append("MetricName: ").append(getMetricName()).append(","); if (getPredicates() != null) sb.append("Predicates: ").append(getPredicates()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Rule == false) return false; Rule other = (Rule) obj; if (other.getRuleId() == null ^ this.getRuleId() == null) return false; if (other.getRuleId() != null && other.getRuleId().equals(this.getRuleId()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getMetricName() == null ^ this.getMetricName() == null) return false; if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false) return false; if (other.getPredicates() == null ^ this.getPredicates() == null) return false; if (other.getPredicates() != null && other.getPredicates().equals(this.getPredicates()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getRuleId() == null) ? 0 : getRuleId().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode()); hashCode = prime * hashCode + ((getPredicates() == null) ? 0 : getPredicates().hashCode()); return hashCode; } @Override public Rule clone() { try { return (Rule) 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.waf.model.waf_regional.transform.RuleMarshaller.getInstance().marshall(this, protocolMarshaller); } }