Package com.softlayer.api.service.container.network.bandwidth.data

Class Summary

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.container.network.bandwidth.data.Summary

@ApiType("SoftLayer_Container_Network_Bandwidth_Data_Summary")
public class Summary
extends Entity

SoftLayer_Container_Network_Bandwidth_Data_Summary models an interface's overall bandwidth usage during it's current billing cycle.

See Also:

SoftLayer_Container_Network_Bandwidth_Data_Summary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	allowedUsage	The amount of bandwidth a server has allocated to it in it's current billing period.
protected boolean	allowedUsageSpecified
protected BigDecimal	estimatedUsage	The amount of bandwidth that a server has used within it's current billing period.
protected boolean	estimatedUsageSpecified
protected BigDecimal	projectedUsage	The amount of bandwidth a server is projected to use within its billing period, based on it's current usage.
protected boolean	projectedUsageSpecified
protected String	usageUnits	The unit of measurement used in a bandwidth data summary.
protected boolean	usageUnitsSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Summary()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getAllowedUsage()
BigDecimal	getEstimatedUsage()
BigDecimal	getProjectedUsage()
String	getUsageUnits()
boolean	isAllowedUsageSpecified()
boolean	isEstimatedUsageSpecified()
boolean	isProjectedUsageSpecified()
boolean	isUsageUnitsSpecified()
void	setAllowedUsage(BigDecimal allowedUsage)
void	setEstimatedUsage(BigDecimal estimatedUsage)
void	setProjectedUsage(BigDecimal projectedUsage)
void	setUsageUnits(String usageUnits)
void	unsetAllowedUsage()
void	unsetEstimatedUsage()
void	unsetProjectedUsage()
void	unsetUsageUnits()

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

allowedUsage

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal allowedUsage

The amount of bandwidth a server has allocated to it in it's current billing period.

allowedUsageSpecified

protected boolean allowedUsageSpecified

estimatedUsage

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal estimatedUsage

The amount of bandwidth that a server has used within it's current billing period.

estimatedUsageSpecified

protected boolean estimatedUsageSpecified

projectedUsage

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal projectedUsage

The amount of bandwidth a server is projected to use within its billing period, based on it's current usage.

projectedUsageSpecified

protected boolean projectedUsageSpecified

usageUnits

@ApiProperty(canBeNullOrNotSet=true) protected String usageUnits

The unit of measurement used in a bandwidth data summary.

usageUnitsSpecified

protected boolean usageUnitsSpecified

Constructor Details

Summary

public Summary()

Method Details

getAllowedUsage

public BigDecimal getAllowedUsage()

setAllowedUsage

public void setAllowedUsage(BigDecimal allowedUsage)

isAllowedUsageSpecified

public boolean isAllowedUsageSpecified()

unsetAllowedUsage

public void unsetAllowedUsage()

getEstimatedUsage

public BigDecimal getEstimatedUsage()

setEstimatedUsage

public void setEstimatedUsage(BigDecimal estimatedUsage)

isEstimatedUsageSpecified

public boolean isEstimatedUsageSpecified()

unsetEstimatedUsage

public void unsetEstimatedUsage()

getProjectedUsage

public BigDecimal getProjectedUsage()

setProjectedUsage

public void setProjectedUsage(BigDecimal projectedUsage)

isProjectedUsageSpecified

public boolean isProjectedUsageSpecified()

unsetProjectedUsage

public void unsetProjectedUsage()

getUsageUnits

public String getUsageUnits()

setUsageUnits

public void setUsageUnits(String usageUnits)

isUsageUnitsSpecified

public boolean isUsageUnitsSpecified()

unsetUsageUnits

public void unsetUsageUnits()