com.amazonaws.services.wafv2.model.AWSManagedRulesBotControlRuleSet 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;
/**
*
* Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet. This
* configuration is used in ManagedRuleGroupConfig.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AWSManagedRulesBotControlRuleSet implements Serializable, Cloneable, StructuredPojo {
/**
*
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted
* level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control
* rule group in the WAF Developer Guide.
*
*/
private String inspectionLevel;
/**
*
* Applies only to the targeted inspection level.
*
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine
* learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*
*/
private Boolean enableMachineLearning;
/**
*
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted
* level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control
* rule group in the WAF Developer Guide.
*
*
* @param inspectionLevel
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The
* targeted level includes all common level rules and adds rules with more advanced inspection criteria. For
* details, see WAF Bot
* Control rule group in the WAF Developer Guide.
* @see InspectionLevel
*/
public void setInspectionLevel(String inspectionLevel) {
this.inspectionLevel = inspectionLevel;
}
/**
*
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted
* level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control
* rule group in the WAF Developer Guide.
*
*
* @return The inspection level to use for the Bot Control rule group. The common level is the least expensive. The
* targeted level includes all common level rules and adds rules with more advanced inspection criteria. For
* details, see WAF Bot
* Control rule group in the WAF Developer Guide.
* @see InspectionLevel
*/
public String getInspectionLevel() {
return this.inspectionLevel;
}
/**
*
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted
* level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control
* rule group in the WAF Developer Guide.
*
*
* @param inspectionLevel
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The
* targeted level includes all common level rules and adds rules with more advanced inspection criteria. For
* details, see WAF Bot
* Control rule group in the WAF Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InspectionLevel
*/
public AWSManagedRulesBotControlRuleSet withInspectionLevel(String inspectionLevel) {
setInspectionLevel(inspectionLevel);
return this;
}
/**
*
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted
* level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control
* rule group in the WAF Developer Guide.
*
*
* @param inspectionLevel
* The inspection level to use for the Bot Control rule group. The common level is the least expensive. The
* targeted level includes all common level rules and adds rules with more advanced inspection criteria. For
* details, see WAF Bot
* Control rule group in the WAF Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InspectionLevel
*/
public AWSManagedRulesBotControlRuleSet withInspectionLevel(InspectionLevel inspectionLevel) {
this.inspectionLevel = inspectionLevel.toString();
return this;
}
/**
*
* Applies only to the targeted inspection level.
*
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine
* learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*
*
* @param enableMachineLearning
* Applies only to the targeted inspection level.
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity.
* Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*/
public void setEnableMachineLearning(Boolean enableMachineLearning) {
this.enableMachineLearning = enableMachineLearning;
}
/**
*
* Applies only to the targeted inspection level.
*
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine
* learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*
*
* @return Applies only to the targeted inspection level.
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity.
* Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*/
public Boolean getEnableMachineLearning() {
return this.enableMachineLearning;
}
/**
*
* Applies only to the targeted inspection level.
*
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine
* learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*
*
* @param enableMachineLearning
* Applies only to the targeted inspection level.
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity.
* Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AWSManagedRulesBotControlRuleSet withEnableMachineLearning(Boolean enableMachineLearning) {
setEnableMachineLearning(enableMachineLearning);
return this;
}
/**
*
* Applies only to the targeted inspection level.
*
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine
* learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*
*
* @return Applies only to the targeted inspection level.
*
* Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity.
* Machine learning is required for the Bot Control rules TGT_ML_CoordinatedActivityLow and
* TGT_ML_CoordinatedActivityMedium, which inspect for anomalous behavior that might indicate
* distributed, coordinated bot activity.
*
*
* For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
*
*
* Default: TRUE
*/
public Boolean isEnableMachineLearning() {
return this.enableMachineLearning;
}
/**
* 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 (getInspectionLevel() != null)
sb.append("InspectionLevel: ").append(getInspectionLevel()).append(",");
if (getEnableMachineLearning() != null)
sb.append("EnableMachineLearning: ").append(getEnableMachineLearning());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AWSManagedRulesBotControlRuleSet == false)
return false;
AWSManagedRulesBotControlRuleSet other = (AWSManagedRulesBotControlRuleSet) obj;
if (other.getInspectionLevel() == null ^ this.getInspectionLevel() == null)
return false;
if (other.getInspectionLevel() != null && other.getInspectionLevel().equals(this.getInspectionLevel()) == false)
return false;
if (other.getEnableMachineLearning() == null ^ this.getEnableMachineLearning() == null)
return false;
if (other.getEnableMachineLearning() != null && other.getEnableMachineLearning().equals(this.getEnableMachineLearning()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInspectionLevel() == null) ? 0 : getInspectionLevel().hashCode());
hashCode = prime * hashCode + ((getEnableMachineLearning() == null) ? 0 : getEnableMachineLearning().hashCode());
return hashCode;
}
@Override
public AWSManagedRulesBotControlRuleSet clone() {
try {
return (AWSManagedRulesBotControlRuleSet) 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.AWSManagedRulesBotControlRuleSetMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}