com.amazonaws.services.waf.model.SubscribedRuleGroupSummary 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.
*
*
*
* A summary of the rule groups you are subscribed to.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SubscribedRuleGroupSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique identifier for a RuleGroup.
*
*/
private String ruleGroupId;
/**
*
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*
*/
private String name;
/**
*
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*
*/
private String metricName;
/**
*
* A unique identifier for a RuleGroup.
*
*
* @param ruleGroupId
* A unique identifier for a RuleGroup.
*/
public void setRuleGroupId(String ruleGroupId) {
this.ruleGroupId = ruleGroupId;
}
/**
*
* A unique identifier for a RuleGroup.
*
*
* @return A unique identifier for a RuleGroup.
*/
public String getRuleGroupId() {
return this.ruleGroupId;
}
/**
*
* A unique identifier for a RuleGroup.
*
*
* @param ruleGroupId
* A unique identifier for a RuleGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SubscribedRuleGroupSummary withRuleGroupId(String ruleGroupId) {
setRuleGroupId(ruleGroupId);
return this;
}
/**
*
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*
*
* @param name
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*
*
* @return A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
*
*
* @param name
* A friendly name or description of the RuleGroup. You can't change the name of a
* RuleGroup after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SubscribedRuleGroupSummary withName(String name) {
setName(name);
return this;
}
/**
*
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*
*
* @param metricName
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
*
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*
*
* @return A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*/
public String getMetricName() {
return this.metricName;
}
/**
*
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
*
*
* @param metricName
* A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SubscribedRuleGroupSummary 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 (getRuleGroupId() != null)
sb.append("RuleGroupId: ").append(getRuleGroupId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).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 SubscribedRuleGroupSummary == false)
return false;
SubscribedRuleGroupSummary other = (SubscribedRuleGroupSummary) obj;
if (other.getRuleGroupId() == null ^ this.getRuleGroupId() == null)
return false;
if (other.getRuleGroupId() != null && other.getRuleGroupId().equals(this.getRuleGroupId()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRuleGroupId() == null) ? 0 : getRuleGroupId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
return hashCode;
}
@Override
public SubscribedRuleGroupSummary clone() {
try {
return (SubscribedRuleGroupSummary) 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.SubscribedRuleGroupSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}