Package com.softlayer.api.service.metric.tracking.object.bandwidth

Class Summary

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.metric.tracking.object.bandwidth.Summary

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

This data type provides commonly used bandwidth summary components for the current billing cycle.

See Also:

SoftLayer_Metric_Tracking_Object_Bandwidth_Summary

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Summary.Mask
static interface	Summary.Service
static interface	Summary.ServiceAsync

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	allocationAmount	This is the amount of bandwidth (measured in gigabytes) allocated for this tracking object.
protected boolean	allocationAmountSpecified
protected Long	allocationId
protected boolean	allocationIdSpecified
protected BigDecimal	amountOut	The amount of outbound bandwidth (measured in gigabytes) currently used this billing period.
protected boolean	amountOutSpecified
protected BigDecimal	averageDailyUsage	The daily average amount of outbound bandwidth usage.
protected boolean	averageDailyUsageSpecified
protected Long	currentlyOverAllocationFlag	A flag that tells whether or not this tracking object's bandwidth usage is already over the allocation.
protected boolean	currentlyOverAllocationFlagSpecified
protected Long	id	The metric tracking id for this resource.
protected boolean	idSpecified
protected BigDecimal	outboundBandwidthAmount	The amount of outbound bandwidth (measured in gigabytes) currently used this billing period
protected boolean	outboundBandwidthAmountSpecified
protected BigDecimal	projectedBandwidthUsage	The amount of bandwidth (measured in gigabytes) of projected usage, using a basic average calculation of daily usage.
protected boolean	projectedBandwidthUsageSpecified
protected Long	projectedOverAllocationFlag	A flag that tells whether or not this tracking object's bandwidth usage is projected to go over the allocation, based on daily average usage.
protected boolean	projectedOverAllocationFlagSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Summary()

Method Summary

Modifier and Type	Method	Description
Summary.Service	asService(ApiClient client)
BigDecimal	getAllocationAmount()
Long	getAllocationId()
BigDecimal	getAmountOut()
BigDecimal	getAverageDailyUsage()
Long	getCurrentlyOverAllocationFlag()
Long	getId()
BigDecimal	getOutboundBandwidthAmount()
BigDecimal	getProjectedBandwidthUsage()
Long	getProjectedOverAllocationFlag()
boolean	isAllocationAmountSpecified()
boolean	isAllocationIdSpecified()
boolean	isAmountOutSpecified()
boolean	isAverageDailyUsageSpecified()
boolean	isCurrentlyOverAllocationFlagSpecified()
boolean	isIdSpecified()
boolean	isOutboundBandwidthAmountSpecified()
boolean	isProjectedBandwidthUsageSpecified()
boolean	isProjectedOverAllocationFlagSpecified()
static Summary.Service	service(ApiClient client)
static Summary.Service	service(ApiClient client, Long id)
void	setAllocationAmount(BigDecimal allocationAmount)
void	setAllocationId(Long allocationId)
void	setAmountOut(BigDecimal amountOut)
void	setAverageDailyUsage(BigDecimal averageDailyUsage)
void	setCurrentlyOverAllocationFlag(Long currentlyOverAllocationFlag)
void	setId(Long id)
void	setOutboundBandwidthAmount(BigDecimal outboundBandwidthAmount)
void	setProjectedBandwidthUsage(BigDecimal projectedBandwidthUsage)
void	setProjectedOverAllocationFlag(Long projectedOverAllocationFlag)
void	unsetAllocationAmount()
void	unsetAllocationId()
void	unsetAmountOut()
void	unsetAverageDailyUsage()
void	unsetCurrentlyOverAllocationFlag()
void	unsetId()
void	unsetOutboundBandwidthAmount()
void	unsetProjectedBandwidthUsage()
void	unsetProjectedOverAllocationFlag()

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 Detail

allocationAmount

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal allocationAmount

This is the amount of bandwidth (measured in gigabytes) allocated for this tracking object.

allocationAmountSpecified

protected boolean allocationAmountSpecified

allocationId

@ApiProperty(canBeNullOrNotSet=true)
protected Long allocationId

allocationIdSpecified

protected boolean allocationIdSpecified

amountOut

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal amountOut

The amount of outbound bandwidth (measured in gigabytes) currently used this billing period. Same as $outboundBandwidthAmount. Aliased for backward compatability.

amountOutSpecified

protected boolean amountOutSpecified

averageDailyUsage

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal averageDailyUsage

The daily average amount of outbound bandwidth usage.

averageDailyUsageSpecified

protected boolean averageDailyUsageSpecified

currentlyOverAllocationFlag

@ApiProperty(canBeNullOrNotSet=true)
protected Long currentlyOverAllocationFlag

A flag that tells whether or not this tracking object's bandwidth usage is already over the allocation. 1 means yes, 0 means no.

currentlyOverAllocationFlagSpecified

protected boolean currentlyOverAllocationFlagSpecified

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

The metric tracking id for this resource.

idSpecified

protected boolean idSpecified

outboundBandwidthAmount

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal outboundBandwidthAmount

The amount of outbound bandwidth (measured in gigabytes) currently used this billing period

outboundBandwidthAmountSpecified

protected boolean outboundBandwidthAmountSpecified

projectedBandwidthUsage

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal projectedBandwidthUsage

The amount of bandwidth (measured in gigabytes) of projected usage, using a basic average calculation of daily usage.

projectedBandwidthUsageSpecified

protected boolean projectedBandwidthUsageSpecified

projectedOverAllocationFlag

@ApiProperty(canBeNullOrNotSet=true)
protected Long projectedOverAllocationFlag

A flag that tells whether or not this tracking object's bandwidth usage is projected to go over the allocation, based on daily average usage. 1 means yes, 0 means no.

projectedOverAllocationFlagSpecified

protected boolean projectedOverAllocationFlagSpecified

Constructor Detail

Summary

public Summary()

Method Detail

getAllocationAmount

public BigDecimal getAllocationAmount()

setAllocationAmount

public void setAllocationAmount(BigDecimal allocationAmount)

isAllocationAmountSpecified

public boolean isAllocationAmountSpecified()

unsetAllocationAmount

public void unsetAllocationAmount()

getAllocationId

public Long getAllocationId()

setAllocationId

public void setAllocationId(Long allocationId)

isAllocationIdSpecified

public boolean isAllocationIdSpecified()

unsetAllocationId

public void unsetAllocationId()

getAmountOut

public BigDecimal getAmountOut()

setAmountOut

public void setAmountOut(BigDecimal amountOut)

isAmountOutSpecified

public boolean isAmountOutSpecified()

unsetAmountOut

public void unsetAmountOut()

getAverageDailyUsage

public BigDecimal getAverageDailyUsage()

setAverageDailyUsage

public void setAverageDailyUsage(BigDecimal averageDailyUsage)

isAverageDailyUsageSpecified

public boolean isAverageDailyUsageSpecified()

unsetAverageDailyUsage

public void unsetAverageDailyUsage()

getCurrentlyOverAllocationFlag

public Long getCurrentlyOverAllocationFlag()

setCurrentlyOverAllocationFlag

public void setCurrentlyOverAllocationFlag(Long currentlyOverAllocationFlag)

isCurrentlyOverAllocationFlagSpecified

public boolean isCurrentlyOverAllocationFlagSpecified()

unsetCurrentlyOverAllocationFlag

public void unsetCurrentlyOverAllocationFlag()

getId

public Long getId()

setId

public void setId(Long id)

isIdSpecified

public boolean isIdSpecified()

unsetId

public void unsetId()

getOutboundBandwidthAmount

public BigDecimal getOutboundBandwidthAmount()

setOutboundBandwidthAmount

public void setOutboundBandwidthAmount(BigDecimal outboundBandwidthAmount)

isOutboundBandwidthAmountSpecified

public boolean isOutboundBandwidthAmountSpecified()

unsetOutboundBandwidthAmount

public void unsetOutboundBandwidthAmount()

getProjectedBandwidthUsage

public BigDecimal getProjectedBandwidthUsage()

setProjectedBandwidthUsage

public void setProjectedBandwidthUsage(BigDecimal projectedBandwidthUsage)

isProjectedBandwidthUsageSpecified

public boolean isProjectedBandwidthUsageSpecified()

unsetProjectedBandwidthUsage

public void unsetProjectedBandwidthUsage()

getProjectedOverAllocationFlag

public Long getProjectedOverAllocationFlag()

setProjectedOverAllocationFlag

public void setProjectedOverAllocationFlag(Long projectedOverAllocationFlag)

isProjectedOverAllocationFlagSpecified

public boolean isProjectedOverAllocationFlagSpecified()

unsetProjectedOverAllocationFlag

public void unsetProjectedOverAllocationFlag()

asService

public Summary.Service asService(ApiClient client)

service

public static Summary.Service service(ApiClient client)

service

public static Summary.Service service(ApiClient client,
                                      Long id)