com.amazonaws.services.waf.model.CreateRuleRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2015-2020 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 CreateRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A friendly name or description of 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 the name of the metric after
* you create the Rule.
*
*/
private String metricName;
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*/
private String changeToken;
/** */
private java.util.List tags;
/**
*
* A friendly name or description of the Rule. You can't change the name of a Rule after you
* create it.
*
*
* @param name
* A friendly name or description of the Rule. You can't change the name of a Rule after
* you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the Rule. You can't change the name of a Rule after you
* create it.
*
*
* @return A friendly name or description of the Rule. You can't change the name of a Rule after
* you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the Rule. You can't change the name of a Rule after you
* create it.
*
*
* @param name
* A friendly name or description of 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 CreateRuleRequest 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 the name of the metric 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
* the name of the metric 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 the name of the metric 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
* the name of the metric 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 the name of the metric 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
* the name of the metric after you create the Rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRuleRequest withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
*/
public void setChangeToken(String changeToken) {
this.changeToken = changeToken;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @return The value returned by the most recent call to GetChangeToken.
*/
public String getChangeToken() {
return this.changeToken;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateRuleRequest 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 CreateRuleRequest 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 CreateRuleRequest 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 (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 CreateRuleRequest == false)
return false;
CreateRuleRequest other = (CreateRuleRequest) 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.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 + ((getChangeToken() == null) ? 0 : getChangeToken().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateRuleRequest clone() {
return (CreateRuleRequest) super.clone();
}
}