Class UpdateSecurityRuleDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20160918")
    public final class UpdateSecurityRuleDetails
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A rule for allowing inbound (direction= INGRESS) or outbound (direction= EGRESS) IP packets.
    Note: Objects should always be created or deserialized using the UpdateSecurityRuleDetails.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 UpdateSecurityRuleDetails.Builder, which maintain a set of all explicitly set fields called UpdateSecurityRuleDetails.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).
    • Method Detail

      • getDescription

        public String getDescription()
        An optional description of your choice for the rule.

        Avoid entering confidential information.

        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 UpdateSecurityRuleDetails.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 UpdateSecurityRuleDetails.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
      • getId

        public String getId()
        The Oracle-assigned ID of the security rule that you want to update.

        You can’t change this value.

        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
      • 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 UpdateSecurityRuleDetails.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()
      • 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