Package com.softlayer.api.service.billing.item.virtual

Class Guest

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.billing.Item

com.softlayer.api.service.billing.item.virtual.Guest

@ApiType("SoftLayer_Billing_Item_Virtual_Guest")
public class Guest
extends Item

The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests.

See Also:

SoftLayer_Billing_Item_Virtual_Guest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Guest.Mask

Nested classes/interfaces inherited from class com.softlayer.api.service.billing.Item

Item.Service, Item.ServiceAsync

Field Summary

Fields

Modifier and Type	Field	Description
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 List<Usage>	billingCyclePrivateBandwidthUsage	The raw private bandwidth usage data for the current billing cycle.
protected Long	billingCyclePrivateBandwidthUsageCount	A count of the raw private bandwidth usage data for the current billing cycle.
protected BigDecimal	billingCyclePrivateUsageIn	The total private inbound bandwidth for this virtual server for the current billing cycle.
protected BigDecimal	billingCyclePrivateUsageOut	The total private outbound bandwidth for this virtual server for the current billing cycle.
protected Long	billingCyclePrivateUsageTotal	The total private bandwidth for this virtual server for the current billing cycle.
protected List<Usage>	billingCyclePublicBandwidthUsage	The raw public bandwidth usage data for the current billing cycle.
protected Long	billingCyclePublicBandwidthUsageCount	A count of the raw public bandwidth usage data for the current billing cycle.
protected BigDecimal	billingCyclePublicUsageIn	The total public inbound bandwidth for this virtual server for the current billing cycle.
protected BigDecimal	billingCyclePublicUsageOut	The total public outbound bandwidth for this virtual server for the current billing cycle.
protected Long	billingCyclePublicUsageTotal	The total public bandwidth for this virtual server for the current billing cycle.
protected Long	monitoringBillingItemCount	A count of
protected List<Item>	monitoringBillingItems
protected Guest	resource	The resource for a cloud server billing item.
protected Long	resourceTableId	The resource (unique identifier) for a server billing item.
protected boolean	resourceTableIdSpecified

Fields inherited from class com.softlayer.api.service.billing.Item

account, activeAgreement, activeAgreementFlag, activeAssociatedChildren, activeAssociatedChildrenCount, activeAssociatedGuestDiskBillingItemCount, activeAssociatedGuestDiskBillingItems, activeBundledItemCount, activeBundledItems, activeCancellationItem, activeChildren, activeChildrenCount, activeFlag, activeSparePoolAssociatedGuestDiskBillingItemCount, activeSparePoolAssociatedGuestDiskBillingItems, activeSparePoolBundledItemCount, activeSparePoolBundledItems, allowCancellationFlag, allowCancellationFlagSpecified, associatedBillingItem, associatedBillingItemHistory, associatedBillingItemHistoryCount, associatedBillingItemId, associatedBillingItemIdSpecified, associatedChildren, associatedChildrenCount, associatedParent, associatedParentCount, availableMatchingVlanCount, availableMatchingVlans, bandwidthAllocation, billableChildren, billableChildrenCount, bundledItemCount, bundledItems, bundleItemCount, bundleItems, canceledChildren, canceledChildrenCount, cancellationDate, cancellationDateSpecified, cancellationReason, cancellationRequestCount, cancellationRequests, category, categoryCode, categoryCodeSpecified, children, childrenCount, childrenWithActiveAgreement, childrenWithActiveAgreementCount, createDate, createDateSpecified, currentHourlyCharge, currentHourlyChargeSpecified, cycleStartDate, cycleStartDateSpecified, description, descriptionSpecified, domainName, domainNameSpecified, downgradeItemCount, downgradeItems, filteredNextInvoiceChildren, filteredNextInvoiceChildrenCount, hostName, hostNameSpecified, hourlyFlag, hourlyRecurringFee, hourlyRecurringFeeSpecified, hoursUsed, hoursUsedSpecified, id, idSpecified, invoiceItem, invoiceItemCount, invoiceItems, item, itemPackage, laborFee, laborFeeSpecified, laborFeeTaxRate, laborFeeTaxRateSpecified, lastBillDate, lastBillDateSpecified, location, modifyDate, modifyDateSpecified, nextBillDate, nextBillDateSpecified, nextInvoiceChildren, nextInvoiceChildrenCount, nextInvoiceTotalOneTimeAmount, nextInvoiceTotalOneTimeTaxAmount, nextInvoiceTotalRecurringAmount, nextInvoiceTotalRecurringTaxAmount, nonZeroNextInvoiceChildren, nonZeroNextInvoiceChildrenCount, notes, notesSpecified, oneTimeFee, oneTimeFeeSpecified, oneTimeFeeTaxRate, oneTimeFeeTaxRateSpecified, orderItem, orderItemId, orderItemIdSpecified, originalLocation, parent, parentId, parentIdSpecified, parentVirtualGuestBillingItem, pendingCancellationFlag, pendingOrderItem, provisionTransaction, recurringFee, recurringFeeSpecified, recurringFeeTaxRate, recurringFeeTaxRateSpecified, recurringMonths, recurringMonthsSpecified, serviceProviderId, serviceProviderIdSpecified, setupFee, setupFeeSpecified, setupFeeTaxRate, setupFeeTaxRateSpecified, softwareDescription, upgradeItem, upgradeItemCount, upgradeItems

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Guest()

Method Summary

Modifier and Type	Method	Description
List<Usage>	getBillingCycleBandwidthUsage()
Long	getBillingCycleBandwidthUsageCount()
List<Usage>	getBillingCyclePrivateBandwidthUsage()
Long	getBillingCyclePrivateBandwidthUsageCount()
BigDecimal	getBillingCyclePrivateUsageIn()
BigDecimal	getBillingCyclePrivateUsageOut()
Long	getBillingCyclePrivateUsageTotal()
List<Usage>	getBillingCyclePublicBandwidthUsage()
Long	getBillingCyclePublicBandwidthUsageCount()
BigDecimal	getBillingCyclePublicUsageIn()
BigDecimal	getBillingCyclePublicUsageOut()
Long	getBillingCyclePublicUsageTotal()
Long	getMonitoringBillingItemCount()
List<Item>	getMonitoringBillingItems()
Guest	getResource()
Long	getResourceTableId()
boolean	isResourceTableIdSpecified()
void	setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount)
void	setBillingCyclePrivateBandwidthUsageCount(Long billingCyclePrivateBandwidthUsageCount)
void	setBillingCyclePrivateUsageIn(BigDecimal billingCyclePrivateUsageIn)
void	setBillingCyclePrivateUsageOut(BigDecimal billingCyclePrivateUsageOut)
void	setBillingCyclePrivateUsageTotal(Long billingCyclePrivateUsageTotal)
void	setBillingCyclePublicBandwidthUsageCount(Long billingCyclePublicBandwidthUsageCount)
void	setBillingCyclePublicUsageIn(BigDecimal billingCyclePublicUsageIn)
void	setBillingCyclePublicUsageOut(BigDecimal billingCyclePublicUsageOut)
void	setBillingCyclePublicUsageTotal(Long billingCyclePublicUsageTotal)
void	setMonitoringBillingItemCount(Long monitoringBillingItemCount)
void	setResource(Guest resource)
void	setResourceTableId(Long resourceTableId)
void	unsetResourceTableId()

Methods inherited from class com.softlayer.api.service.billing.Item

asService, getAccount, getActiveAgreement, getActiveAgreementFlag, getActiveAssociatedChildren, getActiveAssociatedChildrenCount, getActiveAssociatedGuestDiskBillingItemCount, getActiveAssociatedGuestDiskBillingItems, getActiveBundledItemCount, getActiveBundledItems, getActiveCancellationItem, getActiveChildren, getActiveChildrenCount, getActiveFlag, getActiveSparePoolAssociatedGuestDiskBillingItemCount, getActiveSparePoolAssociatedGuestDiskBillingItems, getActiveSparePoolBundledItemCount, getActiveSparePoolBundledItems, getAllowCancellationFlag, getAssociatedBillingItem, getAssociatedBillingItemHistory, getAssociatedBillingItemHistoryCount, getAssociatedBillingItemId, getAssociatedChildren, getAssociatedChildrenCount, getAssociatedParent, getAssociatedParentCount, getAvailableMatchingVlanCount, getAvailableMatchingVlans, getBandwidthAllocation, getBillableChildren, getBillableChildrenCount, getBundledItemCount, getBundledItems, getBundleItemCount, getBundleItems, getCanceledChildren, getCanceledChildrenCount, getCancellationDate, getCancellationReason, getCancellationRequestCount, getCancellationRequests, getCategory, getCategoryCode, getChildren, getChildrenCount, getChildrenWithActiveAgreement, getChildrenWithActiveAgreementCount, getCreateDate, getCurrentHourlyCharge, getCycleStartDate, getDescription, getDomainName, getDowngradeItemCount, getDowngradeItems, getFilteredNextInvoiceChildren, getFilteredNextInvoiceChildrenCount, getHostName, getHourlyFlag, getHourlyRecurringFee, getHoursUsed, getId, getInvoiceItem, getInvoiceItemCount, getInvoiceItems, getItem, getItemPackage, getLaborFee, getLaborFeeTaxRate, getLastBillDate, getLocation, getModifyDate, getNextBillDate, getNextInvoiceChildren, getNextInvoiceChildrenCount, getNextInvoiceTotalOneTimeAmount, getNextInvoiceTotalOneTimeTaxAmount, getNextInvoiceTotalRecurringAmount, getNextInvoiceTotalRecurringTaxAmount, getNonZeroNextInvoiceChildren, getNonZeroNextInvoiceChildrenCount, getNotes, getOneTimeFee, getOneTimeFeeTaxRate, getOrderItem, getOrderItemId, getOriginalLocation, getParent, getParentId, getParentVirtualGuestBillingItem, getPendingCancellationFlag, getPendingOrderItem, getProvisionTransaction, getRecurringFee, getRecurringFeeTaxRate, getRecurringMonths, getServiceProviderId, getSetupFee, getSetupFeeTaxRate, getSoftwareDescription, getUpgradeItem, getUpgradeItemCount, getUpgradeItems, isAllowCancellationFlagSpecified, isAssociatedBillingItemIdSpecified, isCancellationDateSpecified, isCategoryCodeSpecified, isCreateDateSpecified, isCurrentHourlyChargeSpecified, isCycleStartDateSpecified, isDescriptionSpecified, isDomainNameSpecified, isHostNameSpecified, isHourlyRecurringFeeSpecified, isHoursUsedSpecified, isIdSpecified, isLaborFeeSpecified, isLaborFeeTaxRateSpecified, isLastBillDateSpecified, isModifyDateSpecified, isNextBillDateSpecified, isNotesSpecified, isOneTimeFeeSpecified, isOneTimeFeeTaxRateSpecified, isOrderItemIdSpecified, isParentIdSpecified, isRecurringFeeSpecified, isRecurringFeeTaxRateSpecified, isRecurringMonthsSpecified, isServiceProviderIdSpecified, isSetupFeeSpecified, isSetupFeeTaxRateSpecified, service, service, setAccount, setActiveAgreement, setActiveAgreementFlag, setActiveAssociatedChildrenCount, setActiveAssociatedGuestDiskBillingItemCount, setActiveBundledItemCount, setActiveCancellationItem, setActiveChildrenCount, setActiveFlag, setActiveSparePoolAssociatedGuestDiskBillingItemCount, setActiveSparePoolBundledItemCount, setAllowCancellationFlag, setAssociatedBillingItem, setAssociatedBillingItemHistoryCount, setAssociatedBillingItemId, setAssociatedChildrenCount, setAssociatedParentCount, setAvailableMatchingVlanCount, setBandwidthAllocation, setBillableChildrenCount, setBundledItemCount, setBundleItemCount, setCanceledChildrenCount, setCancellationDate, setCancellationReason, setCancellationRequestCount, setCategory, setCategoryCode, setChildrenCount, setChildrenWithActiveAgreementCount, setCreateDate, setCurrentHourlyCharge, setCycleStartDate, setDescription, setDomainName, setDowngradeItemCount, setFilteredNextInvoiceChildrenCount, setHostName, setHourlyFlag, setHourlyRecurringFee, setHoursUsed, setId, setInvoiceItem, setInvoiceItemCount, setItem, setItemPackage, setLaborFee, setLaborFeeTaxRate, setLastBillDate, setLocation, setModifyDate, setNextBillDate, setNextInvoiceChildrenCount, setNextInvoiceTotalOneTimeAmount, setNextInvoiceTotalOneTimeTaxAmount, setNextInvoiceTotalRecurringAmount, setNextInvoiceTotalRecurringTaxAmount, setNonZeroNextInvoiceChildrenCount, setNotes, setOneTimeFee, setOneTimeFeeTaxRate, setOrderItem, setOrderItemId, setOriginalLocation, setParent, setParentId, setParentVirtualGuestBillingItem, setPendingCancellationFlag, setPendingOrderItem, setProvisionTransaction, setRecurringFee, setRecurringFeeTaxRate, setRecurringMonths, setServiceProviderId, setSetupFee, setSetupFeeTaxRate, setSoftwareDescription, setUpgradeItem, setUpgradeItemCount, unsetAllowCancellationFlag, unsetAssociatedBillingItemId, unsetCancellationDate, unsetCategoryCode, unsetCreateDate, unsetCurrentHourlyCharge, unsetCycleStartDate, unsetDescription, unsetDomainName, unsetHostName, unsetHourlyRecurringFee, unsetHoursUsed, unsetId, unsetLaborFee, unsetLaborFeeTaxRate, unsetLastBillDate, unsetModifyDate, unsetNextBillDate, unsetNotes, unsetOneTimeFee, unsetOneTimeFeeTaxRate, unsetOrderItemId, unsetParentId, unsetRecurringFee, unsetRecurringFeeTaxRate, unsetRecurringMonths, unsetServiceProviderId, unsetSetupFee, unsetSetupFeeTaxRate

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

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 server is attached to.

billingCyclePrivateBandwidthUsage

@ApiProperty protected List<Usage> billingCyclePrivateBandwidthUsage

The raw private bandwidth usage data for the current billing cycle.

billingCyclePrivateUsageIn

@ApiProperty protected BigDecimal billingCyclePrivateUsageIn

The total private inbound bandwidth for this virtual server for the current billing cycle.

billingCyclePrivateUsageOut

@ApiProperty protected BigDecimal billingCyclePrivateUsageOut

The total private outbound bandwidth for this virtual server for the current billing cycle.

billingCyclePrivateUsageTotal

@ApiProperty protected Long billingCyclePrivateUsageTotal

The total private bandwidth for this virtual server for the current billing cycle.

billingCyclePublicBandwidthUsage

@ApiProperty protected List<Usage> billingCyclePublicBandwidthUsage

The raw public bandwidth usage data for the current billing cycle.

billingCyclePublicUsageIn

@ApiProperty protected BigDecimal billingCyclePublicUsageIn

The total public inbound bandwidth for this virtual server for the current billing cycle.

billingCyclePublicUsageOut

@ApiProperty protected BigDecimal billingCyclePublicUsageOut

The total public outbound bandwidth for this virtual server for the current billing cycle.

billingCyclePublicUsageTotal

@ApiProperty protected Long billingCyclePublicUsageTotal

The total public bandwidth for this virtual server for the current billing cycle.

monitoringBillingItems

@ApiProperty protected List<Item> monitoringBillingItems

resource

@ApiProperty protected Guest resource

The resource for a cloud server billing item.

resourceTableId

@ApiProperty(canBeNullOrNotSet=true) protected Long resourceTableId

The resource (unique identifier) for a server billing item.

resourceTableIdSpecified

protected boolean resourceTableIdSpecified

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 server is attached to.

billingCyclePrivateBandwidthUsageCount

@ApiProperty protected Long billingCyclePrivateBandwidthUsageCount

A count of the raw private bandwidth usage data for the current billing cycle.

billingCyclePublicBandwidthUsageCount

@ApiProperty protected Long billingCyclePublicBandwidthUsageCount

A count of the raw public bandwidth usage data for the current billing cycle.

monitoringBillingItemCount

@ApiProperty protected Long monitoringBillingItemCount

A count of

Constructor Details

Guest

public Guest()

Method Details

getBillingCycleBandwidthUsage

public List<Usage> getBillingCycleBandwidthUsage()

getBillingCyclePrivateBandwidthUsage

public List<Usage> getBillingCyclePrivateBandwidthUsage()

getBillingCyclePrivateUsageIn

public BigDecimal getBillingCyclePrivateUsageIn()

setBillingCyclePrivateUsageIn

public void setBillingCyclePrivateUsageIn(BigDecimal billingCyclePrivateUsageIn)

getBillingCyclePrivateUsageOut

public BigDecimal getBillingCyclePrivateUsageOut()

setBillingCyclePrivateUsageOut

public void setBillingCyclePrivateUsageOut(BigDecimal billingCyclePrivateUsageOut)

getBillingCyclePrivateUsageTotal

public Long getBillingCyclePrivateUsageTotal()

setBillingCyclePrivateUsageTotal

public void setBillingCyclePrivateUsageTotal(Long billingCyclePrivateUsageTotal)

getBillingCyclePublicBandwidthUsage

public List<Usage> getBillingCyclePublicBandwidthUsage()

getBillingCyclePublicUsageIn

public BigDecimal getBillingCyclePublicUsageIn()

setBillingCyclePublicUsageIn

public void setBillingCyclePublicUsageIn(BigDecimal billingCyclePublicUsageIn)

getBillingCyclePublicUsageOut

public BigDecimal getBillingCyclePublicUsageOut()

setBillingCyclePublicUsageOut

public void setBillingCyclePublicUsageOut(BigDecimal billingCyclePublicUsageOut)

getBillingCyclePublicUsageTotal

public Long getBillingCyclePublicUsageTotal()

setBillingCyclePublicUsageTotal

public void setBillingCyclePublicUsageTotal(Long billingCyclePublicUsageTotal)

getMonitoringBillingItems

public List<Item> getMonitoringBillingItems()

getResource

public Guest getResource()

setResource

public void setResource(Guest resource)

getResourceTableId

public Long getResourceTableId()

setResourceTableId

public void setResourceTableId(Long resourceTableId)

isResourceTableIdSpecified

public boolean isResourceTableIdSpecified()

unsetResourceTableId

public void unsetResourceTableId()

getBillingCycleBandwidthUsageCount

public Long getBillingCycleBandwidthUsageCount()

setBillingCycleBandwidthUsageCount

public void setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount)

getBillingCyclePrivateBandwidthUsageCount

public Long getBillingCyclePrivateBandwidthUsageCount()

setBillingCyclePrivateBandwidthUsageCount

public void setBillingCyclePrivateBandwidthUsageCount(Long billingCyclePrivateBandwidthUsageCount)

getBillingCyclePublicBandwidthUsageCount

public Long getBillingCyclePublicBandwidthUsageCount()

setBillingCyclePublicBandwidthUsageCount

public void setBillingCyclePublicBandwidthUsageCount(Long billingCyclePublicBandwidthUsageCount)

getMonitoringBillingItemCount

public Long getMonitoringBillingItemCount()

setMonitoringBillingItemCount

public void setMonitoringBillingItemCount(Long monitoringBillingItemCount)