com.amazonaws.services.networkfirewall.model.StatefulRuleOptions Maven / Gradle / Ivy
Show all versions of aws-java-sdk-networkfirewall 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.networkfirewall.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule
* groups.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StatefulRuleOptions implements Serializable, Cloneable, StructuredPojo {
/**
*
* Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
* the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata
* evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
*
*/
private String ruleOrder;
/**
*
* Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
* the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata
* evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
*
*
* @param ruleOrder
* Indicates how to manage the order of the rule evaluation for the rule group.
* DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine
* as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more
* information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
* @see RuleOrder
*/
public void setRuleOrder(String ruleOrder) {
this.ruleOrder = ruleOrder;
}
/**
*
* Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
* the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata
* evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
*
*
* @return Indicates how to manage the order of the rule evaluation for the rule group.
* DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine
* as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more
* information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
* @see RuleOrder
*/
public String getRuleOrder() {
return this.ruleOrder;
}
/**
*
* Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
* the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata
* evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
*
*
* @param ruleOrder
* Indicates how to manage the order of the rule evaluation for the rule group.
* DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine
* as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more
* information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleOrder
*/
public StatefulRuleOptions withRuleOrder(String ruleOrder) {
setRuleOrder(ruleOrder);
return this;
}
/**
*
* Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
* the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata
* evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
*
*
* @param ruleOrder
* Indicates how to manage the order of the rule evaluation for the rule group.
* DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine
* as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more
* information, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleOrder
*/
public StatefulRuleOptions withRuleOrder(RuleOrder ruleOrder) {
this.ruleOrder = ruleOrder.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 (getRuleOrder() != null)
sb.append("RuleOrder: ").append(getRuleOrder());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StatefulRuleOptions == false)
return false;
StatefulRuleOptions other = (StatefulRuleOptions) obj;
if (other.getRuleOrder() == null ^ this.getRuleOrder() == null)
return false;
if (other.getRuleOrder() != null && other.getRuleOrder().equals(this.getRuleOrder()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRuleOrder() == null) ? 0 : getRuleOrder().hashCode());
return hashCode;
}
@Override
public StatefulRuleOptions clone() {
try {
return (StatefulRuleOptions) 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.networkfirewall.model.transform.StatefulRuleOptionsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}