com.vmware.vcenter.vcha

Class ClusterTypes.NodeState

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ClusterTypes.NodeState>

com.vmware.vcenter.vcha.ClusterTypes.NodeState

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ClusterTypes

public static final class ClusterTypes.NodeState
extends ApiEnumeration<ClusterTypes.NodeState>

The NodeState enumeration class defines possible state a node can be in a VCHA Cluster. This enumeration was added in vSphere API 6.7.1.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterTypes.NodeState.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ClusterTypes.NodeState	DOWN Node is down and has left the VCHA Cluster.
static ClusterTypes.NodeState	UP Node is up and has joined the VCHA Cluster.

Method Summary

Modifier and Type	Method and Description
ClusterTypes.NodeState.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ClusterTypes.NodeState	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ClusterTypes.NodeState[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

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

Field Detail

UP

public static final ClusterTypes.NodeState UP

Node is up and has joined the VCHA Cluster. This constant field was added in vSphere API 6.7.1.

DOWN

public static final ClusterTypes.NodeState DOWN

Node is down and has left the VCHA Cluster. This constant field was added in vSphere API 6.7.1.

Method Detail

values

public static ClusterTypes.NodeState[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of ClusterTypes.NodeState but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static ClusterTypes.NodeState valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of ClusterTypes.NodeState will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ClusterTypes.NodeState.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public ClusterTypes.NodeState.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then ClusterTypes.NodeState.Values._UNKNOWN enum constant is returned.

The native Java enum is ClusterTypes.NodeState.Values.

Returns:

The Java enum constant. Never null.