com.novell.db.object.bean
Class DiskUsageBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.DiskUsageBean

public class DiskUsageBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'disk-usage'.

The description of the type is:

"A DiskUsage object contains information about disk usage by a Sentinel system."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:

SentinelBean, BeanTransporter

Nested Class Summary

static class

DiskUsageBean.TypeType An enumerated type representing values for the field 'type'.

Field Summary

static String	AVAILABLESPACE The "bean name" of the Sentinel data object field 'AvailableSpace'.
static String	CAPACITYATRISK The "bean name" of the Sentinel data object field 'CapacityAtRisk'.
static String	CAPACITYATRISKSTARTTIME The "bean name" of the Sentinel data object field 'CapacityAtRiskStartTime'.
static String	DAILYRATE The "bean name" of the Sentinel data object field 'DailyRate'.
static String	DAYSCOUNT The "bean name" of the Sentinel data object field 'DaysCount'.
static String	HISTORICALUSAGE The "bean name" of the Sentinel data object field 'HistoricalUsage'.
static String	OVERFLOWSTARTPERCENT The "bean name" of the Sentinel data object field 'OverflowStartPercent'.
static String	OVERFLOWSTOPPERCENT The "bean name" of the Sentinel data object field 'OverflowStopPercent'.
static String	TOTALSPACE The "bean name" of the Sentinel data object field 'TotalSpace'.
static String	TYPE The "bean name" of the Sentinel data object field 'Type'.
static String	USEDSPACE The "bean name" of the Sentinel data object field 'UsedSpace'.

Constructor Summary

	DiskUsageBean() Construct an instance of the bean class.
protected	DiskUsageBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearOverflowStartPercent() Clear any current value for the 'overflow-start' field in the bean.
void	clearOverflowStopPercent() Clear any current value for the 'overflow-stop' field in the bean.
void	clearType() Clear any current value for the 'type' field in the bean.
DiskUsageBean	clone() Create a duplicate of this bean instance, including all field values.
long	getAvailableSpace() Get the value for the 'avail' field.
static BeanMetaData<? extends DiskUsageBean>	getBeanMetaData() Get the metadata class instance for this type.
Date	getCapacityAtRiskStartTime() Get the value for the 'capacity-at-risk-start-time' field.
double	getDailyRate() Get the value for the 'rate' field.
int	getDaysCount() Get the value for the 'days' field.
Collection<HistoricalDiskUsageBean>	getHistoricalUsage() Get the value for the 'hist' field.
int	getOverflowStartPercent() Get the value for the 'overflow-start' field.
int	getOverflowStopPercent() Get the value for the 'overflow-stop' field.
long	getTotalSpace() Get the value for the 'total' field.
DiskUsageBean.TypeType	getType() Get the value for the 'type' field.
long	getUsedSpace() Get the value for the 'used' field.
boolean	isAvailableSpaceClear() Get whether the value for the 'avail' field is clear or not.
boolean	isAvailableSpaceNull() Get whether the 'avail' field has been set to Null or not.
boolean	isCapacityAtRisk() Get the value for the 'capacity-at-risk' field.
boolean	isCapacityAtRiskClear() Get whether the value for the 'capacity-at-risk' field is clear or not.
boolean	isCapacityAtRiskNull() Get whether the 'capacity-at-risk' field has been set to Null or not.
boolean	isCapacityAtRiskStartTimeClear() Get whether the value for the 'capacity-at-risk-start-time' field is clear or not.
boolean	isCapacityAtRiskStartTimeNull() Get whether the 'capacity-at-risk-start-time' field has been set to Null or not.
boolean	isDailyRateClear() Get whether the value for the 'rate' field is clear or not.
boolean	isDailyRateNull() Get whether the 'rate' field has been set to Null or not.
boolean	isDaysCountClear() Get whether the value for the 'days' field is clear or not.
boolean	isDaysCountNull() Get whether the 'days' field has been set to Null or not.
boolean	isHistoricalUsageClear() Get whether the value for the 'hist' field is clear or not.
boolean	isHistoricalUsageNull() Get whether the 'hist' field has been set to Null or not.
boolean	isOverflowStartPercentClear() Get whether the value for the 'overflow-start' field is clear or not.
boolean	isOverflowStartPercentNull() Get whether the 'overflow-start' field has been set to Null or not.
boolean	isOverflowStopPercentClear() Get whether the value for the 'overflow-stop' field is clear or not.
boolean	isOverflowStopPercentNull() Get whether the 'overflow-stop' field has been set to Null or not.
boolean	isTotalSpaceClear() Get whether the value for the 'total' field is clear or not.
boolean	isTotalSpaceNull() Get whether the 'total' field has been set to Null or not.
boolean	isTypeClear() Get whether the value for the 'type' field is clear or not.
boolean	isTypeNull() Get whether the 'type' field has been set to Null or not.
boolean	isUsedSpaceClear() Get whether the value for the 'used' field is clear or not.
boolean	isUsedSpaceNull() Get whether the 'used' field has been set to Null or not.
void	setOverflowStartPercent(int overflowStartPercent) Set the value for the 'overflow-start' field.
void	setOverflowStartPercentNull() Set to Null any current value for the 'overflow-start' field in the bean.
void	setOverflowStopPercent(int overflowStopPercent) Set the value for the 'overflow-stop' field.
void	setOverflowStopPercentNull() Set to Null any current value for the 'overflow-stop' field in the bean.
void	setType(DiskUsageBean.TypeType type) Set the value for the 'type' field.
void	setTypeNull() Set to Null any current value for the 'type' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean

clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DAYSCOUNT

public static final String DAYSCOUNT

The "bean name" of the Sentinel data object field 'DaysCount'. The value is ""days"".

The description of the 'days' field is:

"The number of days included in the historical disk usage data."

See Also:

Constant Field Values

TOTALSPACE

public static final String TOTALSPACE

The "bean name" of the Sentinel data object field 'TotalSpace'. The value is ""total"".

The description of the 'total' field is:

"The total disk space available in kilobytes."

See Also:

Constant Field Values

USEDSPACE

public static final String USEDSPACE

The "bean name" of the Sentinel data object field 'UsedSpace'. The value is ""used"".

The description of the 'used' field is:

"The amount of disk space used in kilobytes."

See Also:

Constant Field Values

HISTORICALUSAGE

public static final String HISTORICALUSAGE

The "bean name" of the Sentinel data object field 'HistoricalUsage'. The value is ""hist"".

The description of the 'hist' field is:

"A list of HistoricalDiskUsage objects that describe the history of disk space consumption in the Sentinel system."

See Also:

Constant Field Values

OVERFLOWSTOPPERCENT

public static final String OVERFLOWSTOPPERCENT

The "bean name" of the Sentinel data object field 'OverflowStopPercent'. The value is ""overflow-stop"".

The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

See Also:

Constant Field Values

OVERFLOWSTARTPERCENT

public static final String OVERFLOWSTARTPERCENT

The "bean name" of the Sentinel data object field 'OverflowStartPercent'. The value is ""overflow-start"".

The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

See Also:

Constant Field Values

CAPACITYATRISK

public static final String CAPACITYATRISK

The "bean name" of the Sentinel data object field 'CapacityAtRisk'. The value is ""capacity-at-risk"".

The description of the 'capacity-at-risk' field is:

"If true, the disk storage is at risk of running out of available space."

See Also:

Constant Field Values

DAILYRATE

public static final String DAILYRATE

The "bean name" of the Sentinel data object field 'DailyRate'. The value is ""rate"".

The description of the 'rate' field is:

"The average rate (in kilobytes) of disk usage."

See Also:

Constant Field Values

CAPACITYATRISKSTARTTIME

public static final String CAPACITYATRISKSTARTTIME

The "bean name" of the Sentinel data object field 'CapacityAtRiskStartTime'. The value is ""capacity-at-risk-start-time"".

The description of the 'capacity-at-risk-start-time' field is:

"The date and time at which the disk storage reached the "at-risk" threshold."

See Also:

Constant Field Values

TYPE

public static final String TYPE

The "bean name" of the Sentinel data object field 'Type'. The value is ""type"".

The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

See Also:

Constant Field Values

AVAILABLESPACE

public static final String AVAILABLESPACE

The "bean name" of the Sentinel data object field 'AvailableSpace'. The value is ""avail"".

The description of the 'avail' field is:

"The amount of free disk space in kilobytes."

See Also:

Constant Field Values

Constructor Detail

DiskUsageBean

public DiskUsageBean()

Construct an instance of the bean class.

DiskUsageBean

protected DiskUsageBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:

metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getCapacityAtRiskStartTime

public Date getCapacityAtRiskStartTime()

Get the value for the 'capacity-at-risk-start-time' field. The description of the 'capacity-at-risk-start-time' field is:

"The date and time at which the disk storage reached the "at-risk" threshold."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

CAPACITYATRISKSTARTTIME

isCapacityAtRiskStartTimeNull

public boolean isCapacityAtRiskStartTimeNull()

Get whether the 'capacity-at-risk-start-time' field has been set to Null or not. The description of the 'capacity-at-risk-start-time' field is:

"The date and time at which the disk storage reached the "at-risk" threshold."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

CAPACITYATRISKSTARTTIME

isCapacityAtRiskStartTimeClear

public boolean isCapacityAtRiskStartTimeClear()

Get whether the value for the 'capacity-at-risk-start-time' field is clear or not. The description of the 'capacity-at-risk-start-time' field is:

"The date and time at which the disk storage reached the "at-risk" threshold."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

CAPACITYATRISKSTARTTIME

getTotalSpace

public long getTotalSpace()

Get the value for the 'total' field. The description of the 'total' field is:

"The total disk space available in kilobytes."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

TOTALSPACE

isTotalSpaceNull

public boolean isTotalSpaceNull()

Get whether the 'total' field has been set to Null or not. The description of the 'total' field is:

"The total disk space available in kilobytes."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

TOTALSPACE

isTotalSpaceClear

public boolean isTotalSpaceClear()

Get whether the value for the 'total' field is clear or not. The description of the 'total' field is:

"The total disk space available in kilobytes."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

TOTALSPACE

getOverflowStopPercent

public int getOverflowStopPercent()

Get the value for the 'overflow-stop' field. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

OVERFLOWSTOPPERCENT

isOverflowStopPercentNull

public boolean isOverflowStopPercentNull()

Get whether the 'overflow-stop' field has been set to Null or not. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setOverflowStopPercentNull(), OVERFLOWSTOPPERCENT

isOverflowStopPercentClear

public boolean isOverflowStopPercentClear()

Get whether the value for the 'overflow-stop' field is clear or not. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearOverflowStopPercent(), OVERFLOWSTOPPERCENT

setOverflowStopPercent

public void setOverflowStopPercent(int overflowStopPercent)

Set the value for the 'overflow-stop' field. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

Parameters:

overflowStopPercent - Value to set

See Also:

OVERFLOWSTOPPERCENT

clearOverflowStopPercent

public void clearOverflowStopPercent()

Clear any current value for the 'overflow-stop' field in the bean. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

Using this method will not clear the server value when the bean is PUT to the server. Use the setOverflowStopPercentNull() method to clear the server's value.

See the description of cleared values.

See Also:

OVERFLOWSTOPPERCENT

setOverflowStopPercentNull

public void setOverflowStopPercentNull()

Set to Null any current value for the 'overflow-stop' field in the bean. The description of the 'overflow-stop' field is:

"The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage."

Using this method will clear the server value when the bean is PUT to the server. Use the clearOverflowStopPercent() method to avoid clearing the server's value.

See the description of Null values.

See Also:

OVERFLOWSTOPPERCENT

getDailyRate

public double getDailyRate()

Get the value for the 'rate' field. The description of the 'rate' field is:

"The average rate (in kilobytes) of disk usage."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DAILYRATE

isDailyRateNull

public boolean isDailyRateNull()

Get whether the 'rate' field has been set to Null or not. The description of the 'rate' field is:

"The average rate (in kilobytes) of disk usage."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

DAILYRATE

isDailyRateClear

public boolean isDailyRateClear()

Get whether the value for the 'rate' field is clear or not. The description of the 'rate' field is:

"The average rate (in kilobytes) of disk usage."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

DAILYRATE

getDaysCount

public int getDaysCount()

Get the value for the 'days' field. The description of the 'days' field is:

"The number of days included in the historical disk usage data."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DAYSCOUNT

isDaysCountNull

public boolean isDaysCountNull()

Get whether the 'days' field has been set to Null or not. The description of the 'days' field is:

"The number of days included in the historical disk usage data."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

DAYSCOUNT

isDaysCountClear

public boolean isDaysCountClear()

Get whether the value for the 'days' field is clear or not. The description of the 'days' field is:

"The number of days included in the historical disk usage data."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

DAYSCOUNT

getOverflowStartPercent

public int getOverflowStartPercent()

Get the value for the 'overflow-start' field. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

OVERFLOWSTARTPERCENT

isOverflowStartPercentNull

public boolean isOverflowStartPercentNull()

Get whether the 'overflow-start' field has been set to Null or not. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setOverflowStartPercentNull(), OVERFLOWSTARTPERCENT

isOverflowStartPercentClear

public boolean isOverflowStartPercentClear()

Get whether the value for the 'overflow-start' field is clear or not. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearOverflowStartPercent(), OVERFLOWSTARTPERCENT

setOverflowStartPercent

public void setOverflowStartPercent(int overflowStartPercent)

Set the value for the 'overflow-start' field. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

Parameters:

overflowStartPercent - Value to set

See Also:

OVERFLOWSTARTPERCENT

clearOverflowStartPercent

public void clearOverflowStartPercent()

Clear any current value for the 'overflow-start' field in the bean. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

Using this method will not clear the server value when the bean is PUT to the server. Use the setOverflowStartPercentNull() method to clear the server's value.

See the description of cleared values.

See Also:

OVERFLOWSTARTPERCENT

setOverflowStartPercentNull

public void setOverflowStartPercentNull()

Set to Null any current value for the 'overflow-start' field in the bean. The description of the 'overflow-start' field is:

"The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space."

Using this method will clear the server value when the bean is PUT to the server. Use the clearOverflowStartPercent() method to avoid clearing the server's value.

See the description of Null values.

See Also:

OVERFLOWSTARTPERCENT

getHistoricalUsage

public Collection<HistoricalDiskUsageBean> getHistoricalUsage()

Get the value for the 'hist' field. The description of the 'hist' field is:

"A list of HistoricalDiskUsage objects that describe the history of disk space consumption in the Sentinel system."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

HISTORICALUSAGE

isHistoricalUsageNull

public boolean isHistoricalUsageNull()

Get whether the 'hist' field has been set to Null or not. The description of the 'hist' field is:

"A list of HistoricalDiskUsage objects that describe the history of disk space consumption in the Sentinel system."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

HISTORICALUSAGE

isHistoricalUsageClear

public boolean isHistoricalUsageClear()

Get whether the value for the 'hist' field is clear or not. The description of the 'hist' field is:

"A list of HistoricalDiskUsage objects that describe the history of disk space consumption in the Sentinel system."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

HISTORICALUSAGE

isCapacityAtRisk

public boolean isCapacityAtRisk()

Get the value for the 'capacity-at-risk' field. The description of the 'capacity-at-risk' field is:

"If true, the disk storage is at risk of running out of available space."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

CAPACITYATRISK

isCapacityAtRiskNull

public boolean isCapacityAtRiskNull()

Get whether the 'capacity-at-risk' field has been set to Null or not. The description of the 'capacity-at-risk' field is:

"If true, the disk storage is at risk of running out of available space."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

CAPACITYATRISK

isCapacityAtRiskClear

public boolean isCapacityAtRiskClear()

Get whether the value for the 'capacity-at-risk' field is clear or not. The description of the 'capacity-at-risk' field is:

"If true, the disk storage is at risk of running out of available space."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

CAPACITYATRISK

getAvailableSpace

public long getAvailableSpace()

Get the value for the 'avail' field. The description of the 'avail' field is:

"The amount of free disk space in kilobytes."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

AVAILABLESPACE

isAvailableSpaceNull

public boolean isAvailableSpaceNull()

Get whether the 'avail' field has been set to Null or not. The description of the 'avail' field is:

"The amount of free disk space in kilobytes."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

AVAILABLESPACE

isAvailableSpaceClear

public boolean isAvailableSpaceClear()

Get whether the value for the 'avail' field is clear or not. The description of the 'avail' field is:

"The amount of free disk space in kilobytes."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

AVAILABLESPACE

getUsedSpace

public long getUsedSpace()

Get the value for the 'used' field. The description of the 'used' field is:

"The amount of disk space used in kilobytes."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

USEDSPACE

isUsedSpaceNull

public boolean isUsedSpaceNull()

Get whether the 'used' field has been set to Null or not. The description of the 'used' field is:

"The amount of disk space used in kilobytes."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

USEDSPACE

isUsedSpaceClear

public boolean isUsedSpaceClear()

Get whether the value for the 'used' field is clear or not. The description of the 'used' field is:

"The amount of disk space used in kilobytes."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

USEDSPACE

getType

public DiskUsageBean.TypeType getType()

Get the value for the 'type' field. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

TYPE

isTypeNull

public boolean isTypeNull()

Get whether the 'type' field has been set to Null or not. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setTypeNull(), TYPE

isTypeClear

public boolean isTypeClear()

Get whether the value for the 'type' field is clear or not. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearType(), TYPE

setType

public void setType(DiskUsageBean.TypeType type)

Set the value for the 'type' field. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

Parameters:

type - Value to set

See Also:

TYPE

clearType

public void clearType()

Clear any current value for the 'type' field in the bean. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

Using this method will not clear the server value when the bean is PUT to the server. Use the setTypeNull() method to clear the server's value.

See the description of cleared values.

See Also:

TYPE

setTypeNull

public void setTypeNull()

Set to Null any current value for the 'type' field in the bean. The description of the 'type' field is:

"The type of disk storage to which the DiskUsage object's data applies."

Using this method will clear the server value when the bean is PUT to the server. Use the clearType() method to avoid clearing the server's value.

See the description of Null values.

See Also:

TYPE

getBeanMetaData

public static BeanMetaData<? extends DiskUsageBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public DiskUsageBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object