Package com.softlayer.api.service.network.vlan

Class 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

    • Field Detail

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

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

      • 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

      • customerManagedFlagSpecified

        protected boolean customerManagedFlagSpecified

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

    • Constructor Detail

      • Firewall

        public Firewall()

    • Method Detail

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

      • 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)