LBServiceStatus (Java SDK for NSX Policy API 4.1.1.0.0)

java.lang.Object
- com.vmware.nsx_policy.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.

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`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`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)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`PolicyRuntimeAlarm`	`getAlarm()`
`java.lang.Long`	`getCpuUsage()` Cpu usage in percentage.
`java.lang.String`	`getEnforcementPointPath()` Policy Path referencing the enforcement point where the info is fetched.
`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.
`java.lang.Long`	`getMemoryUsage()` Memory usage in percentage.
`java.util.List<LBPoolStatus>`	`getPools()` status of load balancer pools.
`java.lang.String`	`getResourceType()` The value of this property is automatically populated to `"LBServiceStatus"`.
`java.lang.String`	`getServicePath()` Load balancer service object path.
`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`	`setAlarm(PolicyRuntimeAlarm alarm)`
`void`	`setCpuUsage(java.lang.Long cpuUsage)` Cpu usage in percentage.
`void`	`setEnforcementPointPath(java.lang.String enforcementPointPath)` Policy Path referencing the enforcement point where the info is fetched.
`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.
`void`	`setMemoryUsage(java.lang.Long memoryUsage)` Memory usage in percentage.
`void`	`setPools(java.util.List<LBPoolStatus> pools)` status of load balancer pools.
`void`	`setServicePath(java.lang.String servicePath)` Load balancer service object path.
`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
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - 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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    activeTransportNodes - New value for the property.
  - getCpuUsage
```
public java.lang.Long getCpuUsage()
```
    Cpu usage in percentage. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCpuUsage
```
public void setCpuUsage(java.lang.Long cpuUsage)
```
    Cpu usage in percentage. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    cpuUsage - New value for the property.
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Error message, if available. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setErrorMessage
```
public void setErrorMessage(java.lang.String errorMessage)
```
    Error message, if available. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    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 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLastUpdateTimestamp
```
public void setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp)
```
    Timestamp when the data was last updated. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    lastUpdateTimestamp - New value for the property.
  - getMemoryUsage
```
public java.lang.Long getMemoryUsage()
```
    Memory usage in percentage. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setMemoryUsage
```
public void setMemoryUsage(java.lang.Long memoryUsage)
```
    Memory usage in percentage. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    memoryUsage - New value for the property.
  - getPools
```
public java.util.List<LBPoolStatus> getPools()
```
    status of load balancer pools. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setPools
```
public void setPools(java.util.List<LBPoolStatus> pools)
```
    status of load balancer pools. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    pools - New value for the property.
  - getServicePath
```
public java.lang.String getServicePath()
```
    Load balancer service object path. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setServicePath
```
public void setServicePath(java.lang.String servicePath)
```
    Load balancer service object path. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    servicePath - New value for the property.
  - getServiceStatus
```
public java.lang.String getServiceStatus()
```
    Possible values are:
    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). This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setServiceStatus
```
public void setServiceStatus(java.lang.String serviceStatus)
```
    Possible values are:
    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). This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    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. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    standbyTransportNodes - New value for the property.
  - getVirtualServers
```
public java.util.List<LBVirtualServerStatus> getVirtualServers()
```
    status of load balancer virtual servers. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setVirtualServers
```
public void setVirtualServers(java.util.List<LBVirtualServerStatus> virtualServers)
```
    status of load balancer virtual servers. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    virtualServers - New value for the property.
  - getAlarm
```
public PolicyRuntimeAlarm getAlarm()
```
    Returns:
    
    The current value of the property.
  - setAlarm
```
public void setAlarm(PolicyRuntimeAlarm alarm)
```
    Parameters:
    
    alarm - New value for the property.
  - getEnforcementPointPath
```
public java.lang.String getEnforcementPointPath()
```
    Policy Path referencing the enforcement point where the info is fetched. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEnforcementPointPath
```
public void setEnforcementPointPath(java.lang.String enforcementPointPath)
```
    Policy Path referencing the enforcement point where the info is fetched. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    enforcementPointPath - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The value of this property is automatically populated to "LBServiceStatus".
    
    Returns:
    
    The current value of 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.

Class LBServiceStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

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

__dynamicStructureFields

Constructor Detail

LBServiceStatus

LBServiceStatus

Method Detail

getActiveTransportNodes

setActiveTransportNodes

getCpuUsage

setCpuUsage

getErrorMessage

setErrorMessage

getInstanceDetailPerTn

setInstanceDetailPerTn

getLastUpdateTimestamp

setLastUpdateTimestamp

getMemoryUsage

setMemoryUsage

getPools

setPools

getServicePath

setServicePath

getServiceStatus

setServiceStatus

getStandbyTransportNodes

setStandbyTransportNodes

getVirtualServers

setVirtualServers

getAlarm

setAlarm

getEnforcementPointPath

setEnforcementPointPath

getResourceType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2