com.amazonaws.services.waf.model.CreateRateBasedRuleRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2019-2024 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.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateRateBasedRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*/
private String name;
/**
*
* A friendly name or description for the metrics for this RateBasedRule. 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 the name
* of the metric after you create the RateBasedRule.
*
*/
private String metricName;
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*/
private String rateKey;
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
* that is specified for this rule.
*
*/
private Long rateLimit;
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
* use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*
*/
private String changeToken;
/** */
private java.util.List tags;
/**
*
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*
* @param name
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*
* @return A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
*
*
* @param name
* A friendly name or description of the RateBasedRule. You can't change the name of a
* RateBasedRule after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withName(String name) {
setName(name);
return this;
}
/**
*
* A friendly name or description for the metrics for this RateBasedRule. 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 the name
* of the metric after you create the RateBasedRule.
*
*
* @param metricName
* A friendly name or description for the metrics for this RateBasedRule. 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 the name of the metric after you create the RateBasedRule.
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
*
* A friendly name or description for the metrics for this RateBasedRule. 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 the name
* of the metric after you create the RateBasedRule.
*
*
* @return A friendly name or description for the metrics for this RateBasedRule. 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 the name of the metric after you create the RateBasedRule.
*/
public String getMetricName() {
return this.metricName;
}
/**
*
* A friendly name or description for the metrics for this RateBasedRule. 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 the name
* of the metric after you create the RateBasedRule.
*
*
* @param metricName
* A friendly name or description for the metrics for this RateBasedRule. 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 the name of the metric after you create the RateBasedRule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
*/
public void setRateKey(String rateKey) {
this.rateKey = rateKey;
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* @return The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
*/
public String getRateKey() {
return this.rateKey;
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RateKey
*/
public CreateRateBasedRuleRequest withRateKey(String rateKey) {
setRateKey(rateKey);
return this;
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @see RateKey
*/
public void setRateKey(RateKey rateKey) {
withRateKey(rateKey);
}
/**
*
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
* rate monitoring. The only valid value for RateKey is IP. IP indicates that
* requests that arrive from the same IP address are subject to the RateLimit that is specified in the
* RateBasedRule.
*
*
* @param rateKey
* The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus
* subject to rate monitoring. The only valid value for RateKey is IP.
* IP indicates that requests that arrive from the same IP address are subject to the
* RateLimit that is specified in the RateBasedRule.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RateKey
*/
public CreateRateBasedRuleRequest withRateKey(RateKey rateKey) {
this.rateKey = rateKey.toString();
return this;
}
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
* that is specified for this rule.
*
*
* @param rateLimit
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the
* action that is specified for this rule.
*/
public void setRateLimit(Long rateLimit) {
this.rateLimit = rateLimit;
}
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
* that is specified for this rule.
*
*
* @return The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the
* action that is specified for this rule.
*/
public Long getRateLimit() {
return this.rateLimit;
}
/**
*
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
* that is specified for this rule.
*
*
* @param rateLimit
* The maximum number of requests, which have an identical value in the field that is specified by
* RateKey, allowed in a five-minute period. If the number of requests exceeds the
* RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the
* action that is specified for this rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withRateLimit(Long rateLimit) {
setRateLimit(rateLimit);
return this;
}
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
* use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*
*
* @param changeToken
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can
* also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
*/
public void setChangeToken(String changeToken) {
this.changeToken = changeToken;
}
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
* use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*
*
* @return The ChangeToken that you used to submit the CreateRateBasedRule request. You
* can also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
*/
public String getChangeToken() {
return this.changeToken;
}
/**
*
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
* use this value to query the status of the request. For more information, see GetChangeTokenStatus.
*
*
* @param changeToken
* The ChangeToken that you used to submit the CreateRateBasedRule request. You can
* also use this value to query the status of the request. For more information, see
* GetChangeTokenStatus.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withChangeToken(String changeToken) {
setChangeToken(changeToken);
return this;
}
/**
*
*
* @return
*/
public java.util.List getTags() {
return tags;
}
/**
*
*
* @param tags
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
*
* @param tags
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRateBasedRuleRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getMetricName() != null)
sb.append("MetricName: ").append(getMetricName()).append(",");
if (getRateKey() != null)
sb.append("RateKey: ").append(getRateKey()).append(",");
if (getRateLimit() != null)
sb.append("RateLimit: ").append(getRateLimit()).append(",");
if (getChangeToken() != null)
sb.append("ChangeToken: ").append(getChangeToken()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateRateBasedRuleRequest == false)
return false;
CreateRateBasedRuleRequest other = (CreateRateBasedRuleRequest) obj;
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.getRateKey() == null ^ this.getRateKey() == null)
return false;
if (other.getRateKey() != null && other.getRateKey().equals(this.getRateKey()) == false)
return false;
if (other.getRateLimit() == null ^ this.getRateLimit() == null)
return false;
if (other.getRateLimit() != null && other.getRateLimit().equals(this.getRateLimit()) == false)
return false;
if (other.getChangeToken() == null ^ this.getChangeToken() == null)
return false;
if (other.getChangeToken() != null && other.getChangeToken().equals(this.getChangeToken()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode + ((getRateKey() == null) ? 0 : getRateKey().hashCode());
hashCode = prime * hashCode + ((getRateLimit() == null) ? 0 : getRateLimit().hashCode());
hashCode = prime * hashCode + ((getChangeToken() == null) ? 0 : getChangeToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateRateBasedRuleRequest clone() {
return (CreateRateBasedRuleRequest) super.clone();
}
}