com.softlayer.api.service.network.vlan.Firewall

@ApiType("SoftLayer_Network_Vlan_Firewall")
public class Firewall
extends Entity

The SoftLayer_Network_Vlan_Firewall data type contains general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.

See Also:: SoftLayer_Network_Vlan_Firewall

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Firewall.Mask`
`static interface`	`Firewall.Service`	The SoftLayer_Network_Vlan_Firewall service accesses general information relating to a single SoftLayer VLAN firewall.
`static interface`	`Firewall.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`accountId`
`protected String`	`administrativeBypassFlag`	A flag to indicate if the firewall is in administrative bypass mode.
`protected boolean`	`administrativeBypassFlagSpecified`
`protected BigDecimal`	`bandwidthAllocation`	A firewall's allotted bandwidth (measured in GB).
`protected List<Usage>`	`billingCycleBandwidthUsage`	The raw bandwidth usage data for the current billing cycle.
`protected Long`	`billingCycleBandwidthUsageCount`	A count of the raw bandwidth usage data for the current billing cycle.
`protected Usage`	`billingCyclePrivateBandwidthUsage`	The raw private bandwidth usage data for the current billing cycle.
`protected Usage`	`billingCyclePublicBandwidthUsage`	The raw public bandwidth usage data for the current billing cycle.
`protected Item`	`billingItem`	The billing item for a Hardware Firewall (Dedicated).
`protected String`	`bypassRequestStatus`	Administrative bypass request status.
`protected Boolean`	`customerManagedFlag`	Whether or not this firewall can be directly logged in to.
`protected boolean`	`customerManagedFlagSpecified`
`protected Location`	`datacenter`	The datacenter that the firewall resides in.
`protected String`	`firewallType`	The firewall device type.
`protected String`	`fullyQualifiedDomainName`	A name reflecting the hostname and domain of the firewall.
`protected Long`	`id`	A firewall's unique identifier.
`protected boolean`	`idSpecified`
`protected Password`	`managementCredentials`	The credentials to log in to a firewall device.
`protected Object`	`metricTrackingObject`	A firewall's metric tracking object.
`protected Long`	`metricTrackingObjectId`	The metric tracking object ID for this firewall.
`protected Long`	`networkFirewallUpdateRequestCount`	A count of the update requests made for this firewall.
`protected List<Request>`	`networkFirewallUpdateRequests`	The update requests made for this firewall.
`protected Gateway`	`networkGateway`	The gateway associated with this firewall, if any.
`protected Vlan`	`networkVlan`	The VLAN object that a firewall is associated with and protecting.
`protected Long`	`networkVlanCount`	A count of the VLAN objects that a firewall is associated with and protecting.
`protected List<Vlan>`	`networkVlans`	The VLAN objects that a firewall is associated with and protecting.
`protected String`	`primaryIpAddress`	A firewall's primary IP address.
`protected boolean`	`primaryIpAddressSpecified`
`protected Long`	`ruleCount`	A count of the currently running rule set of this network component firewall.
`protected List<Rule>`	`rules`	The currently running rule set of this network component firewall.
`protected Long`	`tagReferenceCount`	A count of
`protected List<Reference>`	`tagReferences`
`protected Request`	`upgradeRequest`	A firewall's associated upgrade request object, if any.

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Firewall()

Method Summary

Modifier and Type	Method	Description
`Firewall.Service`	`asService(ApiClient client)`
`Long`	`getAccountId()`
`String`	`getAdministrativeBypassFlag()`
`BigDecimal`	`getBandwidthAllocation()`
`List<Usage>`	`getBillingCycleBandwidthUsage()`
`Long`	`getBillingCycleBandwidthUsageCount()`
`Usage`	`getBillingCyclePrivateBandwidthUsage()`
`Usage`	`getBillingCyclePublicBandwidthUsage()`
`Item`	`getBillingItem()`
`String`	`getBypassRequestStatus()`
`Boolean`	`getCustomerManagedFlag()`
`Location`	`getDatacenter()`
`String`	`getFirewallType()`
`String`	`getFullyQualifiedDomainName()`
`Long`	`getId()`
`Password`	`getManagementCredentials()`
`Object`	`getMetricTrackingObject()`
`Long`	`getMetricTrackingObjectId()`
`Long`	`getNetworkFirewallUpdateRequestCount()`
`List<Request>`	`getNetworkFirewallUpdateRequests()`
`Gateway`	`getNetworkGateway()`
`Vlan`	`getNetworkVlan()`
`Long`	`getNetworkVlanCount()`
`List<Vlan>`	`getNetworkVlans()`
`String`	`getPrimaryIpAddress()`
`Long`	`getRuleCount()`
`List<Rule>`	`getRules()`
`Long`	`getTagReferenceCount()`
`List<Reference>`	`getTagReferences()`
`Request`	`getUpgradeRequest()`
`boolean`	`isAdministrativeBypassFlagSpecified()`
`boolean`	`isCustomerManagedFlagSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isPrimaryIpAddressSpecified()`
`static Firewall.Service`	`service(ApiClient client)`
`static Firewall.Service`	`service(ApiClient client, Long id)`
`void`	`setAccountId(Long accountId)`
`void`	`setAdministrativeBypassFlag(String administrativeBypassFlag)`
`void`	`setBandwidthAllocation(BigDecimal bandwidthAllocation)`
`void`	`setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount)`
`void`	`setBillingCyclePrivateBandwidthUsage(Usage billingCyclePrivateBandwidthUsage)`
`void`	`setBillingCyclePublicBandwidthUsage(Usage billingCyclePublicBandwidthUsage)`
`void`	`setBillingItem(Item billingItem)`
`void`	`setBypassRequestStatus(String bypassRequestStatus)`
`void`	`setCustomerManagedFlag(Boolean customerManagedFlag)`
`void`	`setDatacenter(Location datacenter)`
`void`	`setFirewallType(String firewallType)`
`void`	`setFullyQualifiedDomainName(String fullyQualifiedDomainName)`
`void`	`setId(Long id)`
`void`	`setManagementCredentials(Password managementCredentials)`
`void`	`setMetricTrackingObject(Object metricTrackingObject)`
`void`	`setMetricTrackingObjectId(Long metricTrackingObjectId)`
`void`	`setNetworkFirewallUpdateRequestCount(Long networkFirewallUpdateRequestCount)`
`void`	`setNetworkGateway(Gateway networkGateway)`
`void`	`setNetworkVlan(Vlan networkVlan)`
`void`	`setNetworkVlanCount(Long networkVlanCount)`
`void`	`setPrimaryIpAddress(String primaryIpAddress)`
`void`	`setRuleCount(Long ruleCount)`
`void`	`setTagReferenceCount(Long tagReferenceCount)`
`void`	`setUpgradeRequest(Request upgradeRequest)`
`void`	`unsetAdministrativeBypassFlag()`
`void`	`unsetCustomerManagedFlag()`
`void`	`unsetId()`
`void`	`unsetPrimaryIpAddress()`

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
- accountId
  
  @ApiProperty protected Long accountId
- bandwidthAllocation
  
  @ApiProperty protected BigDecimal bandwidthAllocation
  
  A firewall's allotted bandwidth (measured in GB).
- billingCycleBandwidthUsage
  
  @ApiProperty protected List<Usage> billingCycleBandwidthUsage
  
  The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.
- billingCyclePrivateBandwidthUsage
  
  @ApiProperty protected Usage billingCyclePrivateBandwidthUsage
  
  The raw private bandwidth usage data for the current billing cycle.
- billingCyclePublicBandwidthUsage
  
  @ApiProperty protected Usage billingCyclePublicBandwidthUsage
  
  The raw public bandwidth usage data for the current billing cycle.
- billingItem
  
  @ApiProperty protected Item billingItem
  
  The billing item for a Hardware Firewall (Dedicated).
- bypassRequestStatus
  
  @ApiProperty protected String bypassRequestStatus
  
  Administrative bypass request status.
- datacenter
  
  @ApiProperty protected Location datacenter
  
  The datacenter that the firewall resides in.
- firewallType
  
  @ApiProperty protected String firewallType
  
  The firewall device type.
- fullyQualifiedDomainName
  
  @ApiProperty protected String fullyQualifiedDomainName
  
  A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.
- managementCredentials
  
  @ApiProperty protected Password managementCredentials
  
  The credentials to log in to a firewall device. This is only present for dedicated appliances.
- metricTrackingObject
  
  @ApiProperty protected Object metricTrackingObject
  
  A firewall's metric tracking object.
- metricTrackingObjectId
  
  @ApiProperty protected Long metricTrackingObjectId
  
  The metric tracking object ID for this firewall.
- networkFirewallUpdateRequests
  
  @ApiProperty protected List<Request> networkFirewallUpdateRequests
  
  The update requests made for this firewall.
- networkGateway
  
  @ApiProperty protected Gateway networkGateway
  
  The gateway associated with this firewall, if any.
- networkVlan
  
  @ApiProperty protected Vlan networkVlan
  
  The VLAN object that a firewall is associated with and protecting.
- networkVlans
  
  @ApiProperty protected List<Vlan> networkVlans
  
  The VLAN objects that a firewall is associated with and protecting.
- rules
  
  @ApiProperty protected List<Rule> rules
  
  The currently running rule set of this network component firewall.
- tagReferences
  
  @ApiProperty protected List<Reference> tagReferences
- upgradeRequest
  
  @ApiProperty protected Request upgradeRequest
  
  A firewall's associated upgrade request object, if any.
- administrativeBypassFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected String administrativeBypassFlag
  
  A flag to indicate if the firewall is in administrative bypass mode. In other words, no rules are being applied to the traffic coming through.
- administrativeBypassFlagSpecified
  
  protected boolean administrativeBypassFlagSpecified
- customerManagedFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected Boolean customerManagedFlag
  
  Whether or not this firewall can be directly logged in to.
- customerManagedFlagSpecified
  
  protected boolean customerManagedFlagSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A firewall's unique identifier.
- idSpecified
  
  protected boolean idSpecified
- primaryIpAddress
  
  @ApiProperty(canBeNullOrNotSet=true) protected String primaryIpAddress
  
  A firewall's primary IP address. This field will be the IP shown when doing network traces and reverse DNS and is a read-only property.
- primaryIpAddressSpecified
  
  protected boolean primaryIpAddressSpecified
- billingCycleBandwidthUsageCount
  
  @ApiProperty protected Long billingCycleBandwidthUsageCount
  
  A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.
- networkFirewallUpdateRequestCount
  
  @ApiProperty protected Long networkFirewallUpdateRequestCount
  
  A count of the update requests made for this firewall.
- networkVlanCount
  
  @ApiProperty protected Long networkVlanCount
  
  A count of the VLAN objects that a firewall is associated with and protecting.
- ruleCount
  
  @ApiProperty protected Long ruleCount
  
  A count of the currently running rule set of this network component firewall.
- tagReferenceCount
  
  @ApiProperty protected Long tagReferenceCount
  
  A count of
Constructor Details
- Firewall
  
  public Firewall()
Method Details
- getAccountId
  
  public Long getAccountId()
- setAccountId
  
  public void setAccountId(Long accountId)
- getBandwidthAllocation
  
  public BigDecimal getBandwidthAllocation()
- setBandwidthAllocation
  
  public void setBandwidthAllocation(BigDecimal bandwidthAllocation)
- getBillingCycleBandwidthUsage
  
  public List<Usage> getBillingCycleBandwidthUsage()
- getBillingCyclePrivateBandwidthUsage
  
  public Usage getBillingCyclePrivateBandwidthUsage()
- setBillingCyclePrivateBandwidthUsage
  
  public void setBillingCyclePrivateBandwidthUsage(Usage billingCyclePrivateBandwidthUsage)
- getBillingCyclePublicBandwidthUsage
  
  public Usage getBillingCyclePublicBandwidthUsage()
- setBillingCyclePublicBandwidthUsage
  
  public void setBillingCyclePublicBandwidthUsage(Usage billingCyclePublicBandwidthUsage)
- getBillingItem
  
  public Item getBillingItem()
- setBillingItem
  
  public void setBillingItem(Item billingItem)
- getBypassRequestStatus
  
  public String getBypassRequestStatus()
- setBypassRequestStatus
  
  public void setBypassRequestStatus(String bypassRequestStatus)
- getDatacenter
  
  public Location getDatacenter()
- setDatacenter
  
  public void setDatacenter(Location datacenter)
- getFirewallType
  
  public String getFirewallType()
- setFirewallType
  
  public void setFirewallType(String firewallType)
- getFullyQualifiedDomainName
  
  public String getFullyQualifiedDomainName()
- setFullyQualifiedDomainName
  
  public void setFullyQualifiedDomainName(String fullyQualifiedDomainName)
- getManagementCredentials
  
  public Password getManagementCredentials()
- setManagementCredentials
  
  public void setManagementCredentials(Password managementCredentials)
- getMetricTrackingObject
  
  public Object getMetricTrackingObject()
- setMetricTrackingObject
  
  public void setMetricTrackingObject(Object metricTrackingObject)
- getMetricTrackingObjectId
  
  public Long getMetricTrackingObjectId()
- setMetricTrackingObjectId
  
  public void setMetricTrackingObjectId(Long metricTrackingObjectId)
- getNetworkFirewallUpdateRequests
  
  public List<Request> getNetworkFirewallUpdateRequests()
- getNetworkGateway
  
  public Gateway getNetworkGateway()
- setNetworkGateway
  
  public void setNetworkGateway(Gateway networkGateway)
- getNetworkVlan
  
  public Vlan getNetworkVlan()
- setNetworkVlan
  
  public void setNetworkVlan(Vlan networkVlan)
- getNetworkVlans
  
  public List<Vlan> getNetworkVlans()
- getRules
  
  public List<Rule> getRules()
- getTagReferences
  
  public List<Reference> getTagReferences()
- getUpgradeRequest
  
  public Request getUpgradeRequest()
- setUpgradeRequest
  
  public void setUpgradeRequest(Request upgradeRequest)
- getAdministrativeBypassFlag
  
  public String getAdministrativeBypassFlag()
- setAdministrativeBypassFlag
  
  public void setAdministrativeBypassFlag(String administrativeBypassFlag)
- isAdministrativeBypassFlagSpecified
  
  public boolean isAdministrativeBypassFlagSpecified()
- unsetAdministrativeBypassFlag
  
  public void unsetAdministrativeBypassFlag()
- getCustomerManagedFlag
  
  public Boolean getCustomerManagedFlag()
- setCustomerManagedFlag
  
  public void setCustomerManagedFlag(Boolean customerManagedFlag)
- isCustomerManagedFlagSpecified
  
  public boolean isCustomerManagedFlagSpecified()
- unsetCustomerManagedFlag
  
  public void unsetCustomerManagedFlag()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getPrimaryIpAddress
  
  public String getPrimaryIpAddress()
- setPrimaryIpAddress
  
  public void setPrimaryIpAddress(String primaryIpAddress)
- isPrimaryIpAddressSpecified
  
  public boolean isPrimaryIpAddressSpecified()
- unsetPrimaryIpAddress
  
  public void unsetPrimaryIpAddress()
- getBillingCycleBandwidthUsageCount
  
  public Long getBillingCycleBandwidthUsageCount()
- setBillingCycleBandwidthUsageCount
  
  public void setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount)
- getNetworkFirewallUpdateRequestCount
  
  public Long getNetworkFirewallUpdateRequestCount()
- setNetworkFirewallUpdateRequestCount
  
  public void setNetworkFirewallUpdateRequestCount(Long networkFirewallUpdateRequestCount)
- getNetworkVlanCount
  
  public Long getNetworkVlanCount()
- setNetworkVlanCount
  
  public void setNetworkVlanCount(Long networkVlanCount)
- getRuleCount
  
  public Long getRuleCount()
- setRuleCount
  
  public void setRuleCount(Long ruleCount)
- getTagReferenceCount
  
  public Long getTagReferenceCount()
- setTagReferenceCount
  
  public void setTagReferenceCount(Long tagReferenceCount)
- asService
  
  public Firewall.Service asService(ApiClient client)
- service
  
  public static Firewall.Service service(ApiClient client)
- service
  
  public static Firewall.Service service(ApiClient client, Long id)

Class Firewall

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