com.amazonaws.services.waf.model.RuleSummary 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.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.
*
*
*
* Contains the identifier and the friendly name or description of the Rule.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleSummary 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 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;
/**
*
* 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 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 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 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 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 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 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 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 RuleSummary withRuleId(String ruleId) {
setRuleId(ruleId);
return this;
}
/**
*
* 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 RuleSummary withName(String name) {
setName(name);
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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RuleSummary == false)
return false;
RuleSummary other = (RuleSummary) 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;
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());
return hashCode;
}
@Override
public RuleSummary clone() {
try {
return (RuleSummary) 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.RuleSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}