Package com.oracle.bmc.networkfirewall.model

Class SecurityRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.networkfirewall.model.SecurityRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230501")
public final class SecurityRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Security Rule used in the firewall policy rules.

Security Rules determine whether to block or allow a session based on traffic attributes, such as the source and destination IP address, protocol/port, and the HTTP(S) target URL.
Note: Objects should always be created or deserialized using the SecurityRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SecurityRule.Builder, which maintain a set of all explicitly set fields called SecurityRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityRule.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SecurityRule(String name, SecurityRuleMatchCriteria condition, TrafficActionType action, TrafficInspectionType inspection, RulePosition position, String parentResourceId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SecurityRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
TrafficActionType	getAction()	Types of Action on the Traffic flow.
SecurityRuleMatchCriteria	getCondition()
TrafficInspectionType	getInspection()	Type of inspection to affect the Traffic flow.
String	getName()	Name for the Security rule, must be unique within the policy.
String	getParentResourceId()	OCID of the Network Firewall Policy this security rule belongs to.
RulePosition	getPosition()
int	hashCode()
SecurityRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityRule

@Deprecated
@ConstructorProperties({"name","condition","action","inspection","position","parentResourceId"})
public SecurityRule(String name,
                    SecurityRuleMatchCriteria condition,
                    TrafficActionType action,
                    TrafficInspectionType inspection,
                    RulePosition position,
                    String parentResourceId)

Deprecated.

Method Detail

builder

public static SecurityRule.Builder builder()

Create a new builder.

toBuilder

public SecurityRule.Builder toBuilder()

getName

public String getName()

Name for the Security rule, must be unique within the policy.

Returns:

the value

getCondition

public SecurityRuleMatchCriteria getCondition()

getAction

public TrafficActionType getAction()

Types of Action on the Traffic flow.

ALLOW - Allows the traffic. * DROP - Silently drops the traffic, e.g. without sending a TCP reset. * REJECT - Rejects the traffic, sending a TCP reset to client and/or server as applicable. * INSPECT - Inspects traffic for vulnerability as specified in inspection, which may result in rejection.

Returns:

the value

getInspection

public TrafficInspectionType getInspection()

Type of inspection to affect the Traffic flow.

This is only applicable if action is INSPECT.

INTRUSION_DETECTION - Intrusion Detection. * INTRUSION_PREVENTION - Intrusion Detection and Prevention. Traffic classified as potentially malicious will be rejected as described in type.

Returns:

the value

getPosition

public RulePosition getPosition()

getParentResourceId

public String getParentResourceId()

OCID of the Network Firewall Policy this security rule belongs to.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel