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

Class Usage

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.network.bandwidth.Usage

@ApiType("SoftLayer_Network_Bandwidth_Usage")
public class Usage
extends Entity

The SoftLayer_Network_Bandwidth_Usage data type contains specific information relating to bandwidth utilization at a specific point in time on a given network interface.

See Also:

SoftLayer_Network_Bandwidth_Usage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Usage.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	amountIn	Incoming bandwidth utilization.
protected boolean	amountInSpecified
protected BigDecimal	amountOut	Outgoing bandwidth utilization.
protected boolean	amountOutSpecified
protected BigDecimal	bandwidthUsageDetailTypeId	ID of the bandwidth usage detail type for this record.
protected boolean	bandwidthUsageDetailTypeIdSpecified
protected Object	trackingObject	The tracking object this bandwidth usage record describes.
protected Type	type	In and out bandwidth utilization for a specified time stamp.

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Usage()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getAmountIn()
BigDecimal	getAmountOut()
BigDecimal	getBandwidthUsageDetailTypeId()
Object	getTrackingObject()
Type	getType()
boolean	isAmountInSpecified()
boolean	isAmountOutSpecified()
boolean	isBandwidthUsageDetailTypeIdSpecified()
void	setAmountIn(BigDecimal amountIn)
void	setAmountOut(BigDecimal amountOut)
void	setBandwidthUsageDetailTypeId(BigDecimal bandwidthUsageDetailTypeId)
void	setTrackingObject(Object trackingObject)
void	setType(Type type)
void	unsetAmountIn()
void	unsetAmountOut()
void	unsetBandwidthUsageDetailTypeId()

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

trackingObject

@ApiProperty protected Object trackingObject

The tracking object this bandwidth usage record describes.

type

@ApiProperty protected Type type

In and out bandwidth utilization for a specified time stamp.

amountIn

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal amountIn

Incoming bandwidth utilization.

amountInSpecified

protected boolean amountInSpecified

amountOut

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal amountOut

Outgoing bandwidth utilization.

amountOutSpecified

protected boolean amountOutSpecified

bandwidthUsageDetailTypeId

@ApiProperty(canBeNullOrNotSet=true) protected BigDecimal bandwidthUsageDetailTypeId

ID of the bandwidth usage detail type for this record.

bandwidthUsageDetailTypeIdSpecified

protected boolean bandwidthUsageDetailTypeIdSpecified

Constructor Details

Usage

public Usage()

Method Details

getTrackingObject

public Object getTrackingObject()

setTrackingObject

public void setTrackingObject(Object trackingObject)

getType

public Type getType()

setType

public void setType(Type type)

getAmountIn

public BigDecimal getAmountIn()

setAmountIn

public void setAmountIn(BigDecimal amountIn)

isAmountInSpecified

public boolean isAmountInSpecified()

unsetAmountIn

public void unsetAmountIn()

getAmountOut

public BigDecimal getAmountOut()

setAmountOut

public void setAmountOut(BigDecimal amountOut)

isAmountOutSpecified

public boolean isAmountOutSpecified()

unsetAmountOut

public void unsetAmountOut()

getBandwidthUsageDetailTypeId

public BigDecimal getBandwidthUsageDetailTypeId()

setBandwidthUsageDetailTypeId

public void setBandwidthUsageDetailTypeId(BigDecimal bandwidthUsageDetailTypeId)

isBandwidthUsageDetailTypeIdSpecified

public boolean isBandwidthUsageDetailTypeIdSpecified()

unsetBandwidthUsageDetailTypeId

public void unsetBandwidthUsageDetailTypeId()