com.vmware.nsx.model

Class StatItem

java.lang.Object

com.vmware.nsx.model.StatItem

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class StatItem
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

Displayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatItem.Builder Builder class for StatItem.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	StatItem() Default constructor.
protected	StatItem(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static StatItem	_newInstance(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static StatItem	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.String	getDrilldownId() Id of drilldown widget, if any.
java.util.List<Tooltip>	getTooltip() Multi-line text to be shown on tooltip while hovering over the stat.
java.lang.String	getTotal() If expression for total is specified, it evaluates it.
java.lang.String	getValue() Expression for stat to be displayed.
int	hashCode()
void	setDrilldownId(java.lang.String drilldownId) Id of drilldown widget, if any.
void	setTooltip(java.util.List<Tooltip> tooltip) Multi-line text to be shown on tooltip while hovering over the stat.
void	setTotal(java.lang.String total) If expression for total is specified, it evaluates it.
void	setValue(java.lang.String value) Expression for stat to be displayed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

StatItem

public StatItem()

Default constructor.

StatItem

protected StatItem(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getDrilldownId

public java.lang.String getDrilldownId()

Id of drilldown widget, if any. Id should be a valid id of an existing widget.

Returns:

The current value of the property.

setDrilldownId

public void setDrilldownId(java.lang.String drilldownId)

Id of drilldown widget, if any. Id should be a valid id of an existing widget.

Parameters:

drilldownId - New value for the property.

getTooltip

public java.util.List<Tooltip> getTooltip()

Multi-line text to be shown on tooltip while hovering over the stat.

Returns:

The current value of the property.

setTooltip

public void setTooltip(java.util.List<Tooltip> tooltip)

Multi-line text to be shown on tooltip while hovering over the stat.

Parameters:

tooltip - New value for the property.

getTotal

public java.lang.String getTotal()

If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.

Returns:

The current value of the property.

setTotal

public void setTotal(java.lang.String total)

If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.

Parameters:

total - New value for the property.

getValue

public java.lang.String getValue()

Expression for stat to be displayed.

Returns:

The current value of the property.

setValue

public void setValue(java.lang.String value)

Expression for stat to be displayed.

Parameters:

value - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static StatItem _newInstance(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static StatItem _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.