com.amazonaws.services.wafv2.model.OverrideAction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 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.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The action to use in the place of the action that results from the rule group evaluation. Set the override action to
* none to leave the result of the rule group alone. Set it to count to override the result to count only.
*
*
* You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement
* and ManagedRuleGroupStatement.
*
*
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the
* rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
* Count action, in your rule group reference statement settings.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OverrideAction implements Serializable, Cloneable, StructuredPojo {
/**
*
* Override the rule group evaluation result to count only.
*
*
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want
* the rules in the rule group to only count matches, do not use this and instead use the rule action override
* option, with Count action, in your rule group reference statement settings.
*
*
*/
private CountAction count;
/**
*
* Don't override the rule group evaluation result. This is the most common setting.
*
*/
private NoneAction none;
/**
*
* Override the rule group evaluation result to count only.
*
*
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want
* the rules in the rule group to only count matches, do not use this and instead use the rule action override
* option, with Count action, in your rule group reference statement settings.
*
*
*
* @param count
* Override the rule group evaluation result to count only.
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If
* you want the rules in the rule group to only count matches, do not use this and instead use the rule
* action override option, with Count action, in your rule group reference statement settings.
*
*/
public void setCount(CountAction count) {
this.count = count;
}
/**
*
* Override the rule group evaluation result to count only.
*
*
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want
* the rules in the rule group to only count matches, do not use this and instead use the rule action override
* option, with Count action, in your rule group reference statement settings.
*
*
*
* @return Override the rule group evaluation result to count only.
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If
* you want the rules in the rule group to only count matches, do not use this and instead use the rule
* action override option, with Count action, in your rule group reference statement settings.
*
*/
public CountAction getCount() {
return this.count;
}
/**
*
* Override the rule group evaluation result to count only.
*
*
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want
* the rules in the rule group to only count matches, do not use this and instead use the rule action override
* option, with Count action, in your rule group reference statement settings.
*
*
*
* @param count
* Override the rule group evaluation result to count only.
*
* This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If
* you want the rules in the rule group to only count matches, do not use this and instead use the rule
* action override option, with Count action, in your rule group reference statement settings.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OverrideAction withCount(CountAction count) {
setCount(count);
return this;
}
/**
*
* Don't override the rule group evaluation result. This is the most common setting.
*
*
* @param none
* Don't override the rule group evaluation result. This is the most common setting.
*/
public void setNone(NoneAction none) {
this.none = none;
}
/**
*
* Don't override the rule group evaluation result. This is the most common setting.
*
*
* @return Don't override the rule group evaluation result. This is the most common setting.
*/
public NoneAction getNone() {
return this.none;
}
/**
*
* Don't override the rule group evaluation result. This is the most common setting.
*
*
* @param none
* Don't override the rule group evaluation result. This is the most common setting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OverrideAction withNone(NoneAction none) {
setNone(none);
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 (getCount() != null)
sb.append("Count: ").append(getCount()).append(",");
if (getNone() != null)
sb.append("None: ").append(getNone());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OverrideAction == false)
return false;
OverrideAction other = (OverrideAction) obj;
if (other.getCount() == null ^ this.getCount() == null)
return false;
if (other.getCount() != null && other.getCount().equals(this.getCount()) == false)
return false;
if (other.getNone() == null ^ this.getNone() == null)
return false;
if (other.getNone() != null && other.getNone().equals(this.getNone()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
hashCode = prime * hashCode + ((getNone() == null) ? 0 : getNone().hashCode());
return hashCode;
}
@Override
public OverrideAction clone() {
try {
return (OverrideAction) 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.wafv2.model.transform.OverrideActionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}