com.amazonaws.services.waf.model.RuleGroupUpdate Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2016-2021 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.
*
*
*
* Specifies an ActivatedRule
and indicates whether you want to add it to a RuleGroup
or
* delete it from a RuleGroup
.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RuleGroupUpdate implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
*
*/
private String action;
/**
*
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a
* web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
*
*/
private ActivatedRule activatedRule;
/**
*
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
*
*
* @param action
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
* @see ChangeAction
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
*
*
* @return Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
* @see ChangeAction
*/
public String getAction() {
return this.action;
}
/**
*
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
*
*
* @param action
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeAction
*/
public RuleGroupUpdate withAction(String action) {
setAction(action);
return this;
}
/**
*
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
*
*
* @param action
* Specify INSERT
to add an ActivatedRule
to a RuleGroup
. Use
* DELETE
to remove an ActivatedRule
from a RuleGroup
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChangeAction
*/
public RuleGroupUpdate withAction(ChangeAction action) {
this.action = action.toString();
return this;
}
/**
*
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a
* web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
*
*
* @param activatedRule
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take
* when a web request matches the Rule
(ALLOW
, BLOCK
, or
* COUNT
).
*/
public void setActivatedRule(ActivatedRule activatedRule) {
this.activatedRule = activatedRule;
}
/**
*
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a
* web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
*
*
* @return The ActivatedRule
object specifies a Rule
that you want to insert or delete,
* the priority of the Rule
in the WebACL
, and the action that you want AWS WAF to
* take when a web request matches the Rule
(ALLOW
, BLOCK
, or
* COUNT
).
*/
public ActivatedRule getActivatedRule() {
return this.activatedRule;
}
/**
*
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take when a
* web request matches the Rule
(ALLOW
, BLOCK
, or COUNT
).
*
*
* @param activatedRule
* The ActivatedRule
object specifies a Rule
that you want to insert or delete, the
* priority of the Rule
in the WebACL
, and the action that you want AWS WAF to take
* when a web request matches the Rule
(ALLOW
, BLOCK
, or
* COUNT
).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RuleGroupUpdate withActivatedRule(ActivatedRule activatedRule) {
setActivatedRule(activatedRule);
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 (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getActivatedRule() != null)
sb.append("ActivatedRule: ").append(getActivatedRule());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RuleGroupUpdate == false)
return false;
RuleGroupUpdate other = (RuleGroupUpdate) obj;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getActivatedRule() == null ^ this.getActivatedRule() == null)
return false;
if (other.getActivatedRule() != null && other.getActivatedRule().equals(this.getActivatedRule()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getActivatedRule() == null) ? 0 : getActivatedRule().hashCode());
return hashCode;
}
@Override
public RuleGroupUpdate clone() {
try {
return (RuleGroupUpdate) 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.RuleGroupUpdateMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}