Package com.softlayer.api.service.network.bandwidth.version1

Class Allotment

  • @ApiType("SoftLayer_Network_Bandwidth_Version1_Allotment")
public class Allotment
extends Entity
    The SoftLayer_Network_Bandwidth_Version1_Allotment class provides methods and data structures necessary to work with an array of hardware objects associated with a single Bandwidth Pooling.
    See Also:
    SoftLayer_Network_Bandwidth_Version1_Allotment

    • Field Detail

      • account

        @ApiProperty
protected Account account
        The account associated with this virtual rack.

      • activeDetails

        @ApiProperty
protected List<Detail> activeDetails
        The bandwidth allotment detail records associated with this virtual rack.

      • applicationDeliveryControllers

        @ApiProperty
protected List<Controller> applicationDeliveryControllers
        The Application Delivery Controller contained within a virtual rack.

      • averageDailyPublicBandwidthUsage

        @ApiProperty
protected BigDecimal averageDailyPublicBandwidthUsage
        The average daily public bandwidth usage for the current billing cycle.

      • bandwidthAllotmentType

        @ApiProperty
protected Type bandwidthAllotmentType
        The bandwidth allotment type of this virtual rack.

      • bareMetalInstances

        @ApiProperty
protected List<Hardware> bareMetalInstances
        The bare metal server instances contained within a virtual rack.

      • billingCycleBandwidthUsage

        @ApiProperty
protected List<Usage> billingCycleBandwidthUsage
        A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.

      • billingCyclePrivateBandwidthUsage

        @ApiProperty
protected Usage billingCyclePrivateBandwidthUsage
        A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.

      • billingCyclePublicBandwidthUsage

        @ApiProperty
protected Usage billingCyclePublicBandwidthUsage
        A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.

      • billingCyclePublicUsageTotal

        @ApiProperty
protected Long billingCyclePublicUsageTotal
        The total public bandwidth used in this virtual rack for an account's current billing cycle.

      • billingItem

        @ApiProperty
protected Item billingItem
        A virtual rack's billing item.

      • currentBandwidthSummary

        @ApiProperty
protected Summary currentBandwidthSummary
        An object that provides commonly used bandwidth summary components for the current billing cycle.

      • details

        @ApiProperty
protected List<Detail> details
        The bandwidth allotment detail records associated with this virtual rack.

      • inboundPublicBandwidthUsage

        @ApiProperty
protected BigDecimal inboundPublicBandwidthUsage
        The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.

      • locationGroup

        @ApiProperty
protected Group locationGroup
        The location group associated with this virtual rack.

      • managedBareMetalInstances

        @ApiProperty
protected List<Hardware> managedBareMetalInstances
        The managed bare metal server instances contained within a virtual rack.

      • managedHardware

        @ApiProperty
protected List<Hardware> managedHardware
        The managed hardware contained within a virtual rack.

      • managedVirtualGuests

        @ApiProperty
protected List<Guest> managedVirtualGuests
        The managed Virtual Server contained within a virtual rack.

      • metricTrackingObject

        @ApiProperty
protected VirtualDedicatedRack metricTrackingObject
        A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.

      • metricTrackingObjectId

        @ApiProperty
protected Long metricTrackingObjectId
        The metric tracking object id for this allotment.

      • outboundPublicBandwidthUsage

        @ApiProperty
protected BigDecimal outboundPublicBandwidthUsage
        The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.

      • overBandwidthAllocationFlag

        @ApiProperty
protected Long overBandwidthAllocationFlag
        Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.

      • privateNetworkOnlyHardware

        @ApiProperty
protected List<Hardware> privateNetworkOnlyHardware
        The private network only hardware contained within a virtual rack.

      • projectedOverBandwidthAllocationFlag

        @ApiProperty
protected Long projectedOverBandwidthAllocationFlag
        Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.

      • projectedPublicBandwidthUsage

        @ApiProperty
protected BigDecimal projectedPublicBandwidthUsage
        The projected public outbound bandwidth for this virtual server for the current billing cycle.

      • totalBandwidthAllocated

        @ApiProperty
protected Long totalBandwidthAllocated
        The combined allocated bandwidth for all servers in a virtual rack.

      • virtualGuests

        @ApiProperty
protected List<Guest> virtualGuests
        The Virtual Server contained within a virtual rack.

      • accountIdSpecified

        protected boolean accountIdSpecified

      • bandwidthAllotmentTypeId

        @ApiProperty(canBeNullOrNotSet=true)
protected Long bandwidthAllotmentTypeId
        An identifier marking this allotment as a virtual private rack (1) or a bandwidth pooling(2).

      • bandwidthAllotmentTypeIdSpecified

        protected boolean bandwidthAllotmentTypeIdSpecified

      • createDateSpecified

        protected boolean createDateSpecified

      • endDateSpecified

        protected boolean endDateSpecified

      • idSpecified

        protected boolean idSpecified

      • locationGroupIdSpecified

        protected boolean locationGroupIdSpecified

      • nameSpecified

        protected boolean nameSpecified

      • serviceProviderIdSpecified

        protected boolean serviceProviderIdSpecified

      • activeDetailCount

        @ApiProperty
protected Long activeDetailCount
        A count of the bandwidth allotment detail records associated with this virtual rack.

      • applicationDeliveryControllerCount

        @ApiProperty
protected Long applicationDeliveryControllerCount
        A count of the Application Delivery Controller contained within a virtual rack.

      • bareMetalInstanceCount

        @ApiProperty
protected Long bareMetalInstanceCount
        A count of the bare metal server instances contained within a virtual rack.

      • billingCycleBandwidthUsageCount

        @ApiProperty
protected Long billingCycleBandwidthUsageCount
        A count of a virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.

      • detailCount

        @ApiProperty
protected Long detailCount
        A count of the bandwidth allotment detail records associated with this virtual rack.

      • hardwareCount

        @ApiProperty
protected Long hardwareCount
        A count of the hardware contained within a virtual rack.

      • managedBareMetalInstanceCount

        @ApiProperty
protected Long managedBareMetalInstanceCount
        A count of the managed bare metal server instances contained within a virtual rack.

      • managedHardwareCount

        @ApiProperty
protected Long managedHardwareCount
        A count of the managed hardware contained within a virtual rack.

      • managedVirtualGuestCount

        @ApiProperty
protected Long managedVirtualGuestCount
        A count of the managed Virtual Server contained within a virtual rack.

      • privateNetworkOnlyHardwareCount

        @ApiProperty
protected Long privateNetworkOnlyHardwareCount
        A count of the private network only hardware contained within a virtual rack.

      • virtualGuestCount

        @ApiProperty
protected Long virtualGuestCount
        A count of the Virtual Server contained within a virtual rack.

    • Constructor Detail

      • Allotment

        public Allotment()

    • Method Detail

      • getAccount

        public Account getAccount()

      • setAccount

        public void setAccount​(Account account)

      • getActiveDetails

        public List<Detail> getActiveDetails()

      • getApplicationDeliveryControllers

        public List<Controller> getApplicationDeliveryControllers()

      • getAverageDailyPublicBandwidthUsage

        public BigDecimal getAverageDailyPublicBandwidthUsage()

      • setAverageDailyPublicBandwidthUsage

        public void setAverageDailyPublicBandwidthUsage​(BigDecimal averageDailyPublicBandwidthUsage)

      • getBandwidthAllotmentType

        public Type getBandwidthAllotmentType()

      • setBandwidthAllotmentType

        public void setBandwidthAllotmentType​(Type bandwidthAllotmentType)

      • getBareMetalInstances

        public List<Hardware> getBareMetalInstances()

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

      • getBillingCyclePublicUsageTotal

        public Long getBillingCyclePublicUsageTotal()

      • setBillingCyclePublicUsageTotal

        public void setBillingCyclePublicUsageTotal​(Long billingCyclePublicUsageTotal)

      • getBillingItem

        public Item getBillingItem()

      • setBillingItem

        public void setBillingItem​(Item billingItem)

      • getCurrentBandwidthSummary

        public Summary getCurrentBandwidthSummary()

      • setCurrentBandwidthSummary

        public void setCurrentBandwidthSummary​(Summary currentBandwidthSummary)

      • getInboundPublicBandwidthUsage

        public BigDecimal getInboundPublicBandwidthUsage()

      • setInboundPublicBandwidthUsage

        public void setInboundPublicBandwidthUsage​(BigDecimal inboundPublicBandwidthUsage)

      • getLocationGroup

        public Group getLocationGroup()

      • setLocationGroup

        public void setLocationGroup​(Group locationGroup)

      • getManagedBareMetalInstances

        public List<Hardware> getManagedBareMetalInstances()

      • getManagedHardware

        public List<Hardware> getManagedHardware()

      • getManagedVirtualGuests

        public List<Guest> getManagedVirtualGuests()

      • setMetricTrackingObject

        public void setMetricTrackingObject​(VirtualDedicatedRack metricTrackingObject)

      • getMetricTrackingObjectId

        public Long getMetricTrackingObjectId()

      • setMetricTrackingObjectId

        public void setMetricTrackingObjectId​(Long metricTrackingObjectId)

      • getOutboundPublicBandwidthUsage

        public BigDecimal getOutboundPublicBandwidthUsage()

      • setOutboundPublicBandwidthUsage

        public void setOutboundPublicBandwidthUsage​(BigDecimal outboundPublicBandwidthUsage)

      • getOverBandwidthAllocationFlag

        public Long getOverBandwidthAllocationFlag()

      • setOverBandwidthAllocationFlag

        public void setOverBandwidthAllocationFlag​(Long overBandwidthAllocationFlag)

      • getPrivateNetworkOnlyHardware

        public List<Hardware> getPrivateNetworkOnlyHardware()

      • getProjectedOverBandwidthAllocationFlag

        public Long getProjectedOverBandwidthAllocationFlag()

      • setProjectedOverBandwidthAllocationFlag

        public void setProjectedOverBandwidthAllocationFlag​(Long projectedOverBandwidthAllocationFlag)

      • getProjectedPublicBandwidthUsage

        public BigDecimal getProjectedPublicBandwidthUsage()

      • setProjectedPublicBandwidthUsage

        public void setProjectedPublicBandwidthUsage​(BigDecimal projectedPublicBandwidthUsage)

      • getServiceProvider

        public Provider getServiceProvider()

      • setServiceProvider

        public void setServiceProvider​(Provider serviceProvider)

      • getTotalBandwidthAllocated

        public Long getTotalBandwidthAllocated()

      • setTotalBandwidthAllocated

        public void setTotalBandwidthAllocated​(Long totalBandwidthAllocated)

      • getVirtualGuests

        public List<Guest> getVirtualGuests()

      • getAccountId

        public Long getAccountId()

      • setAccountId

        public void setAccountId​(Long accountId)

      • isAccountIdSpecified

        public boolean isAccountIdSpecified()

      • unsetAccountId

        public void unsetAccountId()

      • getBandwidthAllotmentTypeId

        public Long getBandwidthAllotmentTypeId()

      • setBandwidthAllotmentTypeId

        public void setBandwidthAllotmentTypeId​(Long bandwidthAllotmentTypeId)

      • isBandwidthAllotmentTypeIdSpecified

        public boolean isBandwidthAllotmentTypeIdSpecified()

      • unsetBandwidthAllotmentTypeId

        public void unsetBandwidthAllotmentTypeId()

      • isCreateDateSpecified

        public boolean isCreateDateSpecified()

      • unsetCreateDate

        public void unsetCreateDate()

      • isEndDateSpecified

        public boolean isEndDateSpecified()

      • unsetEndDate

        public void unsetEndDate()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • getLocationGroupId

        public Long getLocationGroupId()

      • setLocationGroupId

        public void setLocationGroupId​(Long locationGroupId)

      • isLocationGroupIdSpecified

        public boolean isLocationGroupIdSpecified()

      • unsetLocationGroupId

        public void unsetLocationGroupId()

      • getName

        public String getName()

      • setName

        public void setName​(String name)

      • isNameSpecified

        public boolean isNameSpecified()

      • unsetName

        public void unsetName()

      • getServiceProviderId

        public Long getServiceProviderId()

      • setServiceProviderId

        public void setServiceProviderId​(Long serviceProviderId)

      • isServiceProviderIdSpecified

        public boolean isServiceProviderIdSpecified()

      • unsetServiceProviderId

        public void unsetServiceProviderId()

      • getActiveDetailCount

        public Long getActiveDetailCount()

      • setActiveDetailCount

        public void setActiveDetailCount​(Long activeDetailCount)

      • getApplicationDeliveryControllerCount

        public Long getApplicationDeliveryControllerCount()

      • setApplicationDeliveryControllerCount

        public void setApplicationDeliveryControllerCount​(Long applicationDeliveryControllerCount)

      • getBareMetalInstanceCount

        public Long getBareMetalInstanceCount()

      • setBareMetalInstanceCount

        public void setBareMetalInstanceCount​(Long bareMetalInstanceCount)

      • getBillingCycleBandwidthUsageCount

        public Long getBillingCycleBandwidthUsageCount()

      • setBillingCycleBandwidthUsageCount

        public void setBillingCycleBandwidthUsageCount​(Long billingCycleBandwidthUsageCount)

      • getDetailCount

        public Long getDetailCount()

      • setDetailCount

        public void setDetailCount​(Long detailCount)

      • getHardwareCount

        public Long getHardwareCount()

      • setHardwareCount

        public void setHardwareCount​(Long hardwareCount)

      • getManagedBareMetalInstanceCount

        public Long getManagedBareMetalInstanceCount()

      • setManagedBareMetalInstanceCount

        public void setManagedBareMetalInstanceCount​(Long managedBareMetalInstanceCount)

      • getManagedHardwareCount

        public Long getManagedHardwareCount()

      • setManagedHardwareCount

        public void setManagedHardwareCount​(Long managedHardwareCount)

      • getManagedVirtualGuestCount

        public Long getManagedVirtualGuestCount()

      • setManagedVirtualGuestCount

        public void setManagedVirtualGuestCount​(Long managedVirtualGuestCount)

      • getPrivateNetworkOnlyHardwareCount

        public Long getPrivateNetworkOnlyHardwareCount()

      • setPrivateNetworkOnlyHardwareCount

        public void setPrivateNetworkOnlyHardwareCount​(Long privateNetworkOnlyHardwareCount)

      • getVirtualGuestCount

        public Long getVirtualGuestCount()

      • setVirtualGuestCount

        public void setVirtualGuestCount​(Long virtualGuestCount)