com.amazonaws.services.wafv2.model.FirewallManagerRuleGroup Maven / Gradle / Ivy
/*
* 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;
/**
*
* A rule group that's defined for an Firewall Manager WAF policy.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FirewallManagerRuleGroup implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*/
private String name;
/**
*
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each
* request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to
* be consecutive, but they must all be different.
*
*/
private Integer priority;
/**
*
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can
* only contain a rule group reference.
*
*/
private FirewallManagerStatement firewallManagerStatement;
/**
*
* 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.
*
*
*/
private OverrideAction overrideAction;
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*/
private VisibilityConfig visibilityConfig;
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @param name
* The name of the rule group. You cannot change the name of a rule group after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @return The name of the rule group. You cannot change the name of a rule group after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @param name
* The name of the rule group. You cannot change the name of a rule group after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallManagerRuleGroup withName(String name) {
setName(name);
return this;
}
/**
*
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each
* request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to
* be consecutive, but they must all be different.
*
*
* @param priority
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates
* each request against the rule groups in order, starting from the lowest priority setting. The priorities
* don't need to be consecutive, but they must all be different.
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
*
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each
* request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to
* be consecutive, but they must all be different.
*
*
* @return If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates
* each request against the rule groups in order, starting from the lowest priority setting. The priorities
* don't need to be consecutive, but they must all be different.
*/
public Integer getPriority() {
return this.priority;
}
/**
*
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each
* request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to
* be consecutive, but they must all be different.
*
*
* @param priority
* If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates
* each request against the rule groups in order, starting from the lowest priority setting. The priorities
* don't need to be consecutive, but they must all be different.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallManagerRuleGroup withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
*
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can
* only contain a rule group reference.
*
*
* @param firewallManagerStatement
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it
* can only contain a rule group reference.
*/
public void setFirewallManagerStatement(FirewallManagerStatement firewallManagerStatement) {
this.firewallManagerStatement = firewallManagerStatement;
}
/**
*
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can
* only contain a rule group reference.
*
*
* @return The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but
* it can only contain a rule group reference.
*/
public FirewallManagerStatement getFirewallManagerStatement() {
return this.firewallManagerStatement;
}
/**
*
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can
* only contain a rule group reference.
*
*
* @param firewallManagerStatement
* The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it
* can only contain a rule group reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallManagerRuleGroup withFirewallManagerStatement(FirewallManagerStatement firewallManagerStatement) {
setFirewallManagerStatement(firewallManagerStatement);
return this;
}
/**
*
* 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.
*
*
*
* @param overrideAction
* 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.
*
*/
public void setOverrideAction(OverrideAction overrideAction) {
this.overrideAction = overrideAction;
}
/**
*
* 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.
*
*
*
* @return 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.
*
*/
public OverrideAction getOverrideAction() {
return this.overrideAction;
}
/**
*
* 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.
*
*
*
* @param overrideAction
* 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallManagerRuleGroup withOverrideAction(OverrideAction overrideAction) {
setOverrideAction(overrideAction);
return this;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public void setVisibilityConfig(VisibilityConfig visibilityConfig) {
this.visibilityConfig = visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig getVisibilityConfig() {
return this.visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallManagerRuleGroup withVisibilityConfig(VisibilityConfig visibilityConfig) {
setVisibilityConfig(visibilityConfig);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getFirewallManagerStatement() != null)
sb.append("FirewallManagerStatement: ").append(getFirewallManagerStatement()).append(",");
if (getOverrideAction() != null)
sb.append("OverrideAction: ").append(getOverrideAction()).append(",");
if (getVisibilityConfig() != null)
sb.append("VisibilityConfig: ").append(getVisibilityConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FirewallManagerRuleGroup == false)
return false;
FirewallManagerRuleGroup other = (FirewallManagerRuleGroup) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getFirewallManagerStatement() == null ^ this.getFirewallManagerStatement() == null)
return false;
if (other.getFirewallManagerStatement() != null && other.getFirewallManagerStatement().equals(this.getFirewallManagerStatement()) == false)
return false;
if (other.getOverrideAction() == null ^ this.getOverrideAction() == null)
return false;
if (other.getOverrideAction() != null && other.getOverrideAction().equals(this.getOverrideAction()) == false)
return false;
if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null)
return false;
if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getFirewallManagerStatement() == null) ? 0 : getFirewallManagerStatement().hashCode());
hashCode = prime * hashCode + ((getOverrideAction() == null) ? 0 : getOverrideAction().hashCode());
hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode());
return hashCode;
}
@Override
public FirewallManagerRuleGroup clone() {
try {
return (FirewallManagerRuleGroup) 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.FirewallManagerRuleGroupMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}