com.softlayer.api.service.network.firewall.update.request.Rule

Direct Known Subclasses:: Version6

@ApiType("SoftLayer_Network_Firewall_Update_Request_Rule")
public class Rule
extends Entity

The SoftLayer_Network_Firewall_Update_Request_Rule type contains information relating to a SoftLayer network firewall update request rule. This rule is a member of a [[SoftLayer Network Firewall Update Request]]. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.

See Also:: SoftLayer_Network_Firewall_Update_Request_Rule

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Rule.Mask`
`static interface`	`Rule.Service`	The SoftLayer_Network_Firewall_Update_Request_Rule service accesses information relating to a SoftLayer network firewall update request rule.
`static interface`	`Rule.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`action`	The action that this update request rule is to take [permit or deny].
`protected boolean`	`actionSpecified`
`protected String`	`destinationIpAddress`	The destination IP address considered for determining rule application.
`protected boolean`	`destinationIpAddressSpecified`
`protected Long`	`destinationIpCidr`	The CIDR is used for determining rule application.
`protected boolean`	`destinationIpCidrSpecified`
`protected String`	`destinationIpSubnetMask`	The destination IP subnet mask considered for determining rule application.
`protected boolean`	`destinationIpSubnetMaskSpecified`
`protected Long`	`destinationPortRangeEnd`	The ending (upper end of range) destination port considered for determining rule application.
`protected boolean`	`destinationPortRangeEndSpecified`
`protected Long`	`destinationPortRangeStart`	The starting (lower end of range) destination port considered for determining rule application.
`protected boolean`	`destinationPortRangeStartSpecified`
`protected Request`	`firewallUpdateRequest`	The update request that this rule belongs to.
`protected Long`	`firewallUpdateRequestId`	The unique identifier of the firewall update request that a firewall update request rule is associated with.
`protected boolean`	`firewallUpdateRequestIdSpecified`
`protected Long`	`id`	A Firewall update request rule's internal identifier.
`protected boolean`	`idSpecified`
`protected String`	`notes`	The notes field for the firewall update request rule.
`protected boolean`	`notesSpecified`
`protected Long`	`orderValue`	The numeric value describing the order in which the rule should be applied.
`protected boolean`	`orderValueSpecified`
`protected String`	`protocol`	The protocol considered for determining rule application.
`protected boolean`	`protocolSpecified`
`protected String`	`sourceIpAddress`	The source IP address considered for determining rule application.
`protected boolean`	`sourceIpAddressSpecified`
`protected Long`	`sourceIpCidr`	The CIDR is used for determining rule application.
`protected boolean`	`sourceIpCidrSpecified`
`protected String`	`sourceIpSubnetMask`	The source IP subnet mask considered for determining rule application.
`protected boolean`	`sourceIpSubnetMaskSpecified`
`protected Long`	`version`	Whether this rule is an IPv4 rule or an IPv6 rule.
`protected boolean`	`versionSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Rule()

Method Summary

Modifier and Type	Method	Description
`Rule.Service`	`asService(ApiClient client)`
`String`	`getAction()`
`String`	`getDestinationIpAddress()`
`Long`	`getDestinationIpCidr()`
`String`	`getDestinationIpSubnetMask()`
`Long`	`getDestinationPortRangeEnd()`
`Long`	`getDestinationPortRangeStart()`
`Request`	`getFirewallUpdateRequest()`
`Long`	`getFirewallUpdateRequestId()`
`Long`	`getId()`
`String`	`getNotes()`
`Long`	`getOrderValue()`
`String`	`getProtocol()`
`String`	`getSourceIpAddress()`
`Long`	`getSourceIpCidr()`
`String`	`getSourceIpSubnetMask()`
`Long`	`getVersion()`
`boolean`	`isActionSpecified()`
`boolean`	`isDestinationIpAddressSpecified()`
`boolean`	`isDestinationIpCidrSpecified()`
`boolean`	`isDestinationIpSubnetMaskSpecified()`
`boolean`	`isDestinationPortRangeEndSpecified()`
`boolean`	`isDestinationPortRangeStartSpecified()`
`boolean`	`isFirewallUpdateRequestIdSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isNotesSpecified()`
`boolean`	`isOrderValueSpecified()`
`boolean`	`isProtocolSpecified()`
`boolean`	`isSourceIpAddressSpecified()`
`boolean`	`isSourceIpCidrSpecified()`
`boolean`	`isSourceIpSubnetMaskSpecified()`
`boolean`	`isVersionSpecified()`
`static Rule.Service`	`service(ApiClient client)`
`static Rule.Service`	`service(ApiClient client, Long id)`
`void`	`setAction(String action)`
`void`	`setDestinationIpAddress(String destinationIpAddress)`
`void`	`setDestinationIpCidr(Long destinationIpCidr)`
`void`	`setDestinationIpSubnetMask(String destinationIpSubnetMask)`
`void`	`setDestinationPortRangeEnd(Long destinationPortRangeEnd)`
`void`	`setDestinationPortRangeStart(Long destinationPortRangeStart)`
`void`	`setFirewallUpdateRequest(Request firewallUpdateRequest)`
`void`	`setFirewallUpdateRequestId(Long firewallUpdateRequestId)`
`void`	`setId(Long id)`
`void`	`setNotes(String notes)`
`void`	`setOrderValue(Long orderValue)`
`void`	`setProtocol(String protocol)`
`void`	`setSourceIpAddress(String sourceIpAddress)`
`void`	`setSourceIpCidr(Long sourceIpCidr)`
`void`	`setSourceIpSubnetMask(String sourceIpSubnetMask)`
`void`	`setVersion(Long version)`
`void`	`unsetAction()`
`void`	`unsetDestinationIpAddress()`
`void`	`unsetDestinationIpCidr()`
`void`	`unsetDestinationIpSubnetMask()`
`void`	`unsetDestinationPortRangeEnd()`
`void`	`unsetDestinationPortRangeStart()`
`void`	`unsetFirewallUpdateRequestId()`
`void`	`unsetId()`
`void`	`unsetNotes()`
`void`	`unsetOrderValue()`
`void`	`unsetProtocol()`
`void`	`unsetSourceIpAddress()`
`void`	`unsetSourceIpCidr()`
`void`	`unsetSourceIpSubnetMask()`
`void`	`unsetVersion()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- firewallUpdateRequest
  
  @ApiProperty protected Request firewallUpdateRequest
  
  The update request that this rule belongs to.
- action
  
  @ApiProperty(canBeNullOrNotSet=true) protected String action
  
  The action that this update request 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
- firewallUpdateRequestId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long firewallUpdateRequestId
  
  The unique identifier of the firewall update request that a firewall update request rule is associated with.
- firewallUpdateRequestIdSpecified
  
  protected boolean firewallUpdateRequestIdSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A Firewall update request rule's internal identifier.
- idSpecified
  
  protected boolean idSpecified
- notes
  
  @ApiProperty(canBeNullOrNotSet=true) protected String notes
  
  The notes field for the firewall update request 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
- 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
- getFirewallUpdateRequest
  
  public Request getFirewallUpdateRequest()
- setFirewallUpdateRequest
  
  public void setFirewallUpdateRequest(Request firewallUpdateRequest)
- 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()
- getFirewallUpdateRequestId
  
  public Long getFirewallUpdateRequestId()
- setFirewallUpdateRequestId
  
  public void setFirewallUpdateRequestId(Long firewallUpdateRequestId)
- isFirewallUpdateRequestIdSpecified
  
  public boolean isFirewallUpdateRequestIdSpecified()
- unsetFirewallUpdateRequestId
  
  public void unsetFirewallUpdateRequestId()
- 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()
- getVersion
  
  public Long getVersion()
- setVersion
  
  public void setVersion(Long version)
- isVersionSpecified
  
  public boolean isVersionSpecified()
- unsetVersion
  
  public void unsetVersion()
- asService
  
  public Rule.Service asService(ApiClient client)
- service
  
  public static Rule.Service service(ApiClient client)
- service
  
  public static Rule.Service service(ApiClient client, Long id)

Class Rule

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details