com.vmware.nsx.model

Class LbServiceStatus

java.lang.Object

com.vmware.nsx.model.LbServiceStatus

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	SERVICE_STATUS_DETACHED
static java.lang.String	SERVICE_STATUS_DISABLED
static java.lang.String	SERVICE_STATUS_DOWN
static java.lang.String	SERVICE_STATUS_ERROR
static java.lang.String	SERVICE_STATUS_NO_STANDBY
static java.lang.String	SERVICE_STATUS_PARTIALLY_UP
static java.lang.String	SERVICE_STATUS_UNKNOWN
static java.lang.String	SERVICE_STATUS_UP

Constructor Summary

Constructors

Modifier	Constructor and Description
	LbServiceStatus() Default constructor.
protected	LbServiceStatus(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 LbServiceStatus	_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 LbServiceStatus	_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.util.List<java.lang.String>	getActiveTransportNodes() Ids of load balancer service related active transport nodes
java.lang.Long	getCpuUsage() Cpu usage in percentage format: int64
java.lang.String	getErrorMessage() Error message, if available
java.util.List<LbServiceInstanceDetailPerTransportNode>	getInstanceDetailPerTn() Details of load balancer service instance per transport node.
java.lang.Long	getLastUpdateTimestamp() Timestamp when the data was last updated format: int64
java.lang.Long	getMemoryUsage() Memory usage in percentage format: int64
java.util.List<LbPoolStatus>	getPools() status of load balancer pools
java.lang.String	getServiceId() Load balancer service identifier
java.lang.String	getServiceStatus() Possible values are: SERVICE_STATUS_UP SERVICE_STATUS_PARTIALLY_UP SERVICE_STATUS_DOWN SERVICE_STATUS_ERROR SERVICE_STATUS_NO_STANDBY SERVICE_STATUS_DETACHED SERVICE_STATUS_DISABLED SERVICE_STATUS_UNKNOWN UP means the load balancer service is working fine on both transport-nodes(if have); PARTIALLY_UP means that some DLB instances on transport node are working successfully and some instances are not working successfully; DOWN means the load balancer service is down on both transport-nodes (if have), hence the load balancer will not respond to any requests; ERROR means error happens on transport-node(s) or no status is reported from transport-node(s).
java.util.List<java.lang.String>	getStandbyTransportNodes() Ids of load balancer service related standby transport nodes
java.util.List<LbVirtualServerStatus>	getVirtualServers() status of load balancer virtual servers
int	hashCode()
void	setActiveTransportNodes(java.util.List<java.lang.String> activeTransportNodes) Ids of load balancer service related active transport nodes
void	setCpuUsage(java.lang.Long cpuUsage) Cpu usage in percentage format: int64
void	setErrorMessage(java.lang.String errorMessage) Error message, if available
void	setInstanceDetailPerTn(java.util.List<LbServiceInstanceDetailPerTransportNode> instanceDetailPerTn) Details of load balancer service instance per transport node.
void	setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp) Timestamp when the data was last updated format: int64
void	setMemoryUsage(java.lang.Long memoryUsage) Memory usage in percentage format: int64
void	setPools(java.util.List<LbPoolStatus> pools) status of load balancer pools
void	setServiceId(java.lang.String serviceId) Load balancer service identifier
void	setServiceStatus(java.lang.String serviceStatus) Possible values are: SERVICE_STATUS_UP SERVICE_STATUS_PARTIALLY_UP SERVICE_STATUS_DOWN SERVICE_STATUS_ERROR SERVICE_STATUS_NO_STANDBY SERVICE_STATUS_DETACHED SERVICE_STATUS_DISABLED SERVICE_STATUS_UNKNOWN UP means the load balancer service is working fine on both transport-nodes(if have); PARTIALLY_UP means that some DLB instances on transport node are working successfully and some instances are not working successfully; DOWN means the load balancer service is down on both transport-nodes (if have), hence the load balancer will not respond to any requests; ERROR means error happens on transport-node(s) or no status is reported from transport-node(s).
void	setStandbyTransportNodes(java.util.List<java.lang.String> standbyTransportNodes) Ids of load balancer service related standby transport nodes
void	setVirtualServers(java.util.List<LbVirtualServerStatus> virtualServers) status of load balancer virtual servers
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_STATUS_UP

public static final java.lang.String SERVICE_STATUS_UP

See Also:

Constant Field Values

SERVICE_STATUS_PARTIALLY_UP

public static final java.lang.String SERVICE_STATUS_PARTIALLY_UP

See Also:

Constant Field Values

SERVICE_STATUS_DOWN

public static final java.lang.String SERVICE_STATUS_DOWN

See Also:

Constant Field Values

SERVICE_STATUS_ERROR

public static final java.lang.String SERVICE_STATUS_ERROR

See Also:

Constant Field Values

SERVICE_STATUS_NO_STANDBY

public static final java.lang.String SERVICE_STATUS_NO_STANDBY

See Also:

Constant Field Values

SERVICE_STATUS_DETACHED

public static final java.lang.String SERVICE_STATUS_DETACHED

See Also:

Constant Field Values

SERVICE_STATUS_DISABLED

public static final java.lang.String SERVICE_STATUS_DISABLED

See Also:

Constant Field Values

SERVICE_STATUS_UNKNOWN

public static final java.lang.String SERVICE_STATUS_UNKNOWN

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

LbServiceStatus

public LbServiceStatus()

Default constructor.

LbServiceStatus

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

Method Detail

getActiveTransportNodes

public java.util.List<java.lang.String> getActiveTransportNodes()

Ids of load balancer service related active transport nodes

Returns:

The current value of the property.

setActiveTransportNodes

public void setActiveTransportNodes(java.util.List<java.lang.String> activeTransportNodes)

Ids of load balancer service related active transport nodes

Parameters:

activeTransportNodes - New value for the property.

getCpuUsage

public java.lang.Long getCpuUsage()

Cpu usage in percentage format: int64

Returns:

The current value of the property.

setCpuUsage

public void setCpuUsage(java.lang.Long cpuUsage)

Cpu usage in percentage format: int64

Parameters:

cpuUsage - New value for the property.

getErrorMessage

public java.lang.String getErrorMessage()

Error message, if available

Returns:

The current value of the property.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Error message, if available

Parameters:

errorMessage - New value for the property.

getInstanceDetailPerTn

public java.util.List<LbServiceInstanceDetailPerTransportNode> getInstanceDetailPerTn()

Details of load balancer service instance per transport node.

Returns:

The current value of the property.

setInstanceDetailPerTn

public void setInstanceDetailPerTn(java.util.List<LbServiceInstanceDetailPerTransportNode> instanceDetailPerTn)

Details of load balancer service instance per transport node.

Parameters:

instanceDetailPerTn - New value for the property.

getLastUpdateTimestamp

public java.lang.Long getLastUpdateTimestamp()

Timestamp when the data was last updated format: int64

Returns:

The current value of the property.

setLastUpdateTimestamp

public void setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp)

Timestamp when the data was last updated format: int64

Parameters:

lastUpdateTimestamp - New value for the property.

getMemoryUsage

public java.lang.Long getMemoryUsage()

Memory usage in percentage format: int64

Returns:

The current value of the property.

setMemoryUsage

public void setMemoryUsage(java.lang.Long memoryUsage)

Memory usage in percentage format: int64

Parameters:

memoryUsage - New value for the property.

getPools

public java.util.List<LbPoolStatus> getPools()

status of load balancer pools

Returns:

The current value of the property.

setPools

public void setPools(java.util.List<LbPoolStatus> pools)

status of load balancer pools

Parameters:

pools - New value for the property.

getServiceId

public java.lang.String getServiceId()

Load balancer service identifier

Returns:

The current value of the property.

setServiceId

public void setServiceId(java.lang.String serviceId)

Load balancer service identifier

Parameters:

serviceId - New value for the property.

getServiceStatus

public java.lang.String getServiceStatus()

Possible values are:

• SERVICE_STATUS_UP
• SERVICE_STATUS_PARTIALLY_UP
• SERVICE_STATUS_DOWN
• SERVICE_STATUS_ERROR
• SERVICE_STATUS_NO_STANDBY
• SERVICE_STATUS_DETACHED
• SERVICE_STATUS_DISABLED
• SERVICE_STATUS_UNKNOWN

UP means the load balancer service is working fine on both transport-nodes(if have); PARTIALLY_UP means that some DLB instances on transport node are working successfully and some instances are not working successfully; DOWN means the load balancer service is down on both transport-nodes (if have), hence the load balancer will not respond to any requests; ERROR means error happens on transport-node(s) or no status is reported from transport-node(s). The load balancer service may be working (or not working); NO_STANDBY means load balancer service is working in one of the transport node while not in the other transport-node (if have). Hence if the load balancer service in the working transport-node goes down, the load balancer service will go down; DETACHED means that the load balancer service has no attachment setting and is not instantiated in any transport nodes; DISABLED means that admin state of load balancer service is DISABLED; UNKNOWN means that no status reported from transport-nodes.The load balancer service may be working(or not working).

Returns:

The current value of the property.

setServiceStatus

public void setServiceStatus(java.lang.String serviceStatus)

Possible values are:

• SERVICE_STATUS_UP
• SERVICE_STATUS_PARTIALLY_UP
• SERVICE_STATUS_DOWN
• SERVICE_STATUS_ERROR
• SERVICE_STATUS_NO_STANDBY
• SERVICE_STATUS_DETACHED
• SERVICE_STATUS_DISABLED
• SERVICE_STATUS_UNKNOWN

UP means the load balancer service is working fine on both transport-nodes(if have); PARTIALLY_UP means that some DLB instances on transport node are working successfully and some instances are not working successfully; DOWN means the load balancer service is down on both transport-nodes (if have), hence the load balancer will not respond to any requests; ERROR means error happens on transport-node(s) or no status is reported from transport-node(s). The load balancer service may be working (or not working); NO_STANDBY means load balancer service is working in one of the transport node while not in the other transport-node (if have). Hence if the load balancer service in the working transport-node goes down, the load balancer service will go down; DETACHED means that the load balancer service has no attachment setting and is not instantiated in any transport nodes; DISABLED means that admin state of load balancer service is DISABLED; UNKNOWN means that no status reported from transport-nodes.The load balancer service may be working(or not working).

Parameters:

serviceStatus - New value for the property.

getStandbyTransportNodes

public java.util.List<java.lang.String> getStandbyTransportNodes()

Ids of load balancer service related standby transport nodes

Returns:

The current value of the property.

setStandbyTransportNodes

public void setStandbyTransportNodes(java.util.List<java.lang.String> standbyTransportNodes)

Ids of load balancer service related standby transport nodes

Parameters:

standbyTransportNodes - New value for the property.

getVirtualServers

public java.util.List<LbVirtualServerStatus> getVirtualServers()

status of load balancer virtual servers

Returns:

The current value of the property.

setVirtualServers

public void setVirtualServers(java.util.List<LbVirtualServerStatus> virtualServers)

status of load balancer virtual servers

Parameters:

virtualServers - 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 LbServiceStatus _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 LbServiceStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)

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