Package com.oracle.bmc.vnmonitoring.model

Class SecurityRule

java.lang.Object

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

com.oracle.bmc.vnmonitoring.model.SecurityRule

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

A security rule is one of the items in a NetworkSecurityGroup.

It is a virtual firewall rule for the VNICs in the network security group. A rule can be for either inbound ( direction= INGRESS) or outbound (direction= EGRESS) IP packets.
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
static class	SecurityRule.DestinationType	Type of destination for the rule.
static class	SecurityRule.Direction	Direction of the security rule.
static class	SecurityRule.SourceType	Type of source for the rule.

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 description, String destination, SecurityRule.DestinationType destinationType, SecurityRule.Direction direction, IcmpOptions icmpOptions, String id, Boolean isStateless, Boolean isValid, String protocol, String source, SecurityRule.SourceType sourceType, TcpOptions tcpOptions, Date timeCreated, UdpOptions udpOptions)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SecurityRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	An optional description of your choice for the rule.
String	getDestination()	Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
SecurityRule.DestinationType	getDestinationType()	Type of destination for the rule.
SecurityRule.Direction	getDirection()	Direction of the security rule.
IcmpOptions	getIcmpOptions()
String	getId()	An Oracle-assigned identifier for the security rule.
Boolean	getIsStateless()	A stateless rule allows traffic in one direction.
Boolean	getIsValid()	Whether the rule is valid.
String	getProtocol()	The transport protocol.
String	getSource()	Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
SecurityRule.SourceType	getSourceType()	Type of source for the rule.
TcpOptions	getTcpOptions()
Date	getTimeCreated()	The date and time the security rule was created.
UdpOptions	getUdpOptions()
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({"description","destination","destinationType","direction","icmpOptions","id","isStateless","isValid","protocol","source","sourceType","tcpOptions","timeCreated","udpOptions"})
public SecurityRule(String description,
                    String destination,
                    SecurityRule.DestinationType destinationType,
                    SecurityRule.Direction direction,
                    IcmpOptions icmpOptions,
                    String id,
                    Boolean isStateless,
                    Boolean isValid,
                    String protocol,
                    String source,
                    SecurityRule.SourceType sourceType,
                    TcpOptions tcpOptions,
                    Date timeCreated,
                    UdpOptions udpOptions)

Deprecated.

Method Detail

builder

public static SecurityRule.Builder builder()

Create a new builder.

toBuilder

public SecurityRule.Builder toBuilder()

getDescription

public String getDescription()

An optional description of your choice for the rule.

Returns:

the value

getDestination

public String getDestination()

Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.

Allowed values:

An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

The cidrBlock value for a Service, if you're setting up a security rule for traffic destined for a particular Service through a service gateway. For example: oci-phx-objectstorage.

The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.

Returns:

the value

getDestinationType

public SecurityRule.DestinationType getDestinationType()

Type of destination for the rule.

Required if direction = EGRESS.

Allowed values:

CIDR_BLOCK: If the rule's destination is an IP address range in CIDR notation.

SERVICE_CIDR_BLOCK: If the rule's destination is the cidrBlock value for a Service (the rule is for traffic destined for a particular Service through a service gateway).

NETWORK_SECURITY_GROUP: If the rule's destination is the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

Returns:

the value

getDirection

public SecurityRule.Direction getDirection()

Direction of the security rule.

Set to EGRESS for rules to allow outbound IP packets, or INGRESS for rules to allow inbound IP packets.

Returns:

the value

getIcmpOptions

public IcmpOptions getIcmpOptions()

getId

public String getId()

An Oracle-assigned identifier for the security rule.

You specify this ID when you want to update or delete the rule.

Example: 04ABEC

Returns:

the value

getIsStateless

public Boolean getIsStateless()

A stateless rule allows traffic in one direction.

Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

Returns:

the value

getIsValid

public Boolean getIsValid()

Whether the rule is valid.

The value is True when the rule is first created. If the rule’s source or destination is a network security group, the value changes to False if that network security group is deleted.

Returns:

the value

getProtocol

public String getProtocol()

The transport protocol.

Specify either all or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP (“1”), TCP (“6”), UDP (“17”), and ICMPv6 (“58”).

Returns:

the value

getSource

public String getSource()

Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.

Allowed values:

An IP address range in CIDR notation. For example: 192.168.1.0/24 or 2001:0db8:0123:45::/56 IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).

The cidrBlock value for a Service, if you're setting up a security rule for traffic coming from a particular Service through a service gateway. For example: oci-phx-objectstorage.

The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.

Returns:

the value

getSourceType

public SecurityRule.SourceType getSourceType()

Type of source for the rule.

Required if direction = INGRESS.

CIDR_BLOCK: If the rule's source is an IP address range in CIDR notation.

SERVICE_CIDR_BLOCK: If the rule's source is the cidrBlock value for a Service (the rule is for traffic coming from a particular Service through a service gateway).

NETWORK_SECURITY_GROUP: If the rule's source is the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup.

Returns:

the value

getTcpOptions

public TcpOptions getTcpOptions()

getTimeCreated

public Date getTimeCreated()

The date and time the security rule was created.

Format defined by RFC3339.

Returns:

the value

getUdpOptions

public UdpOptions getUdpOptions()

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