com.amazonaws.services.wafv2.model.ActionCondition Maven / Gradle / Ivy
/*
* Copyright 2018-2023 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;
/**
*
* A single action condition for a Condition in a logging filter.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ActionCondition implements Serializable, Cloneable, StructuredPojo {
/**
*
* The action setting that a log record must contain in order to meet the condition. This is the action that WAF
* applied to the web request.
*
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action override
* to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and
* also on rules that have a rule action override of Count.
*
*/
private String action;
/**
*
* The action setting that a log record must contain in order to meet the condition. This is the action that WAF
* applied to the web request.
*
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action override
* to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and
* also on rules that have a rule action override of Count.
*
*
* @param action
* The action setting that a log record must contain in order to meet the condition. This is the action that
* WAF applied to the web request.
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action
* override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on
* excluded rules and also on rules that have a rule action override of Count.
* @see ActionValue
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* The action setting that a log record must contain in order to meet the condition. This is the action that WAF
* applied to the web request.
*
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action override
* to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and
* also on rules that have a rule action override of Count.
*
*
* @return The action setting that a log record must contain in order to meet the condition. This is the action that
* WAF applied to the web request.
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action
* override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on
* excluded rules and also on rules that have a rule action override of Count.
* @see ActionValue
*/
public String getAction() {
return this.action;
}
/**
*
* The action setting that a log record must contain in order to meet the condition. This is the action that WAF
* applied to the web request.
*
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action override
* to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and
* also on rules that have a rule action override of Count.
*
*
* @param action
* The action setting that a log record must contain in order to meet the condition. This is the action that
* WAF applied to the web request.
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action
* override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on
* excluded rules and also on rules that have a rule action override of Count.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionValue
*/
public ActionCondition withAction(String action) {
setAction(action);
return this;
}
/**
*
* The action setting that a log record must contain in order to meet the condition. This is the action that WAF
* applied to the web request.
*
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action override
* to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on excluded rules and
* also on rules that have a rule action override of Count.
*
*
* @param action
* The action setting that a log record must contain in order to meet the condition. This is the action that
* WAF applied to the web request.
*
* For rule groups, this is either the configured rule action setting, or if you've applied a rule action
* override to the rule, it's the override action. The value EXCLUDED_AS_COUNT matches on
* excluded rules and also on rules that have a rule action override of Count.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ActionValue
*/
public ActionCondition withAction(ActionValue action) {
this.action = action.toString();
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());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ActionCondition == false)
return false;
ActionCondition other = (ActionCondition) obj;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
return hashCode;
}
@Override
public ActionCondition clone() {
try {
return (ActionCondition) 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.ActionConditionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}