java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.vlan.firewall.Rule

@ApiType("SoftLayer_Network_Vlan_Firewall_Rule")
public class Rule
extends Entity
A SoftLayer_Network_Component_Firewall_Rule object type represents a currently running firewall rule and contains relative information. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
See Also:
SoftLayer_Network_Vlan_Firewall_Rule
  • Field Details

    • networkComponentFirewall

      @ApiProperty protected Firewall networkComponentFirewall
      The network component firewall that this rule belongs to.
    • action

      @ApiProperty(canBeNullOrNotSet=true) protected String action
      The action that the rule is to take [permit or deny].
    • actionSpecified

      protected boolean actionSpecified
    • destinationIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String destinationIpAddress
      The destination IP address considered for determining rule application.
    • destinationIpAddressSpecified

      protected boolean destinationIpAddressSpecified
    • destinationIpCidr

      @ApiProperty(canBeNullOrNotSet=true) protected Long destinationIpCidr
      The CIDR is used for determining rule application. This value will
    • destinationIpCidrSpecified

      protected boolean destinationIpCidrSpecified
    • destinationIpSubnetMask

      @ApiProperty(canBeNullOrNotSet=true) protected String destinationIpSubnetMask
      The destination IP subnet mask considered for determining rule application.
    • destinationIpSubnetMaskSpecified

      protected boolean destinationIpSubnetMaskSpecified
    • destinationPortRangeEnd

      @ApiProperty(canBeNullOrNotSet=true) protected Long destinationPortRangeEnd
      The ending (upper end of range) destination port considered for determining rule application.
    • destinationPortRangeEndSpecified

      protected boolean destinationPortRangeEndSpecified
    • destinationPortRangeStart

      @ApiProperty(canBeNullOrNotSet=true) protected Long destinationPortRangeStart
      The starting (lower end of range) destination port considered for determining rule application.
    • destinationPortRangeStartSpecified

      protected boolean destinationPortRangeStartSpecified
    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      The rule's internal identifier.
    • idSpecified

      protected boolean idSpecified
    • notes

      @ApiProperty(canBeNullOrNotSet=true) protected String notes
      The notes field for the rule.
    • notesSpecified

      protected boolean notesSpecified
    • orderValue

      @ApiProperty(canBeNullOrNotSet=true) protected Long orderValue
      The numeric value describing the order in which the rule should be applied.
    • orderValueSpecified

      protected boolean orderValueSpecified
    • protocol

      @ApiProperty(canBeNullOrNotSet=true) protected String protocol
      The protocol considered for determining rule application.
    • protocolSpecified

      protected boolean protocolSpecified
    • sourceIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String sourceIpAddress
      The source IP address considered for determining rule application.
    • sourceIpAddressSpecified

      protected boolean sourceIpAddressSpecified
    • sourceIpCidr

      @ApiProperty(canBeNullOrNotSet=true) protected Long sourceIpCidr
      The CIDR is used for determining rule application. This value will
    • sourceIpCidrSpecified

      protected boolean sourceIpCidrSpecified
    • sourceIpSubnetMask

      @ApiProperty(canBeNullOrNotSet=true) protected String sourceIpSubnetMask
      The source IP subnet mask considered for determining rule application.
    • sourceIpSubnetMaskSpecified

      protected boolean sourceIpSubnetMaskSpecified
    • status

      @ApiProperty(canBeNullOrNotSet=true) protected String status
      Current status of the network component firewall.
    • statusSpecified

      protected boolean statusSpecified
    • version

      @ApiProperty(canBeNullOrNotSet=true) protected Long version
      Whether this rule is an IPv4 rule or an IPv6 rule. If
    • versionSpecified

      protected boolean versionSpecified
  • Constructor Details

    • Rule

      public Rule()
  • Method Details

    • getNetworkComponentFirewall

      public Firewall getNetworkComponentFirewall()
    • setNetworkComponentFirewall

      public void setNetworkComponentFirewall​(Firewall networkComponentFirewall)
    • getAction

      public String getAction()
    • setAction

      public void setAction​(String action)
    • isActionSpecified

      public boolean isActionSpecified()
    • unsetAction

      public void unsetAction()
    • getDestinationIpAddress

      public String getDestinationIpAddress()
    • setDestinationIpAddress

      public void setDestinationIpAddress​(String destinationIpAddress)
    • isDestinationIpAddressSpecified

      public boolean isDestinationIpAddressSpecified()
    • unsetDestinationIpAddress

      public void unsetDestinationIpAddress()
    • getDestinationIpCidr

      public Long getDestinationIpCidr()
    • setDestinationIpCidr

      public void setDestinationIpCidr​(Long destinationIpCidr)
    • isDestinationIpCidrSpecified

      public boolean isDestinationIpCidrSpecified()
    • unsetDestinationIpCidr

      public void unsetDestinationIpCidr()
    • getDestinationIpSubnetMask

      public String getDestinationIpSubnetMask()
    • setDestinationIpSubnetMask

      public void setDestinationIpSubnetMask​(String destinationIpSubnetMask)
    • isDestinationIpSubnetMaskSpecified

      public boolean isDestinationIpSubnetMaskSpecified()
    • unsetDestinationIpSubnetMask

      public void unsetDestinationIpSubnetMask()
    • getDestinationPortRangeEnd

      public Long getDestinationPortRangeEnd()
    • setDestinationPortRangeEnd

      public void setDestinationPortRangeEnd​(Long destinationPortRangeEnd)
    • isDestinationPortRangeEndSpecified

      public boolean isDestinationPortRangeEndSpecified()
    • unsetDestinationPortRangeEnd

      public void unsetDestinationPortRangeEnd()
    • getDestinationPortRangeStart

      public Long getDestinationPortRangeStart()
    • setDestinationPortRangeStart

      public void setDestinationPortRangeStart​(Long destinationPortRangeStart)
    • isDestinationPortRangeStartSpecified

      public boolean isDestinationPortRangeStartSpecified()
    • unsetDestinationPortRangeStart

      public void unsetDestinationPortRangeStart()
    • getId

      public Long getId()
    • setId

      public void setId​(Long id)
    • isIdSpecified

      public boolean isIdSpecified()
    • unsetId

      public void unsetId()
    • getNotes

      public String getNotes()
    • setNotes

      public void setNotes​(String notes)
    • isNotesSpecified

      public boolean isNotesSpecified()
    • unsetNotes

      public void unsetNotes()
    • getOrderValue

      public Long getOrderValue()
    • setOrderValue

      public void setOrderValue​(Long orderValue)
    • isOrderValueSpecified

      public boolean isOrderValueSpecified()
    • unsetOrderValue

      public void unsetOrderValue()
    • getProtocol

      public String getProtocol()
    • setProtocol

      public void setProtocol​(String protocol)
    • isProtocolSpecified

      public boolean isProtocolSpecified()
    • unsetProtocol

      public void unsetProtocol()
    • getSourceIpAddress

      public String getSourceIpAddress()
    • setSourceIpAddress

      public void setSourceIpAddress​(String sourceIpAddress)
    • isSourceIpAddressSpecified

      public boolean isSourceIpAddressSpecified()
    • unsetSourceIpAddress

      public void unsetSourceIpAddress()
    • getSourceIpCidr

      public Long getSourceIpCidr()
    • setSourceIpCidr

      public void setSourceIpCidr​(Long sourceIpCidr)
    • isSourceIpCidrSpecified

      public boolean isSourceIpCidrSpecified()
    • unsetSourceIpCidr

      public void unsetSourceIpCidr()
    • getSourceIpSubnetMask

      public String getSourceIpSubnetMask()
    • setSourceIpSubnetMask

      public void setSourceIpSubnetMask​(String sourceIpSubnetMask)
    • isSourceIpSubnetMaskSpecified

      public boolean isSourceIpSubnetMaskSpecified()
    • unsetSourceIpSubnetMask

      public void unsetSourceIpSubnetMask()
    • getStatus

      public String getStatus()
    • setStatus

      public void setStatus​(String status)
    • isStatusSpecified

      public boolean isStatusSpecified()
    • unsetStatus

      public void unsetStatus()
    • getVersion

      public Long getVersion()
    • setVersion

      public void setVersion​(Long version)
    • isVersionSpecified

      public boolean isVersionSpecified()
    • unsetVersion

      public void unsetVersion()