com.vmware.vcenter.vcha

Class ClusterTypes.ClusterState

java.lang.Object

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

com.vmware.vcenter.vcha.ClusterTypes.ClusterState

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ClusterTypes

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

The ClusterState enumeration class defines the possible for 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.ClusterState.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ClusterTypes.ClusterState	DEGRADED A VCHA Cluster is said to be in a degraded state for either or all of the following reasons: There is a node loss.
static ClusterTypes.ClusterState	HEALTHY All three nodes in a VCHA Cluster are healthy and connected.
static ClusterTypes.ClusterState	ISOLATED All three nodes are isolated from each other.

Method Summary

Modifier and Type	Method and Description
ClusterTypes.ClusterState.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ClusterTypes.ClusterState	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ClusterTypes.ClusterState[]	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

HEALTHY

public static final ClusterTypes.ClusterState HEALTHY

All three nodes in a VCHA Cluster are healthy and connected. State replication between Active and Passive node is working and both nodes are in sync. This constant field was added in vSphere API 6.7.1.

DEGRADED

public static final ClusterTypes.ClusterState DEGRADED

A VCHA Cluster is said to be in a degraded state for either or all of the following reasons:

• There is a node loss.
• State replication between the Active and Passive node fails.

. This constant field was added in vSphere API 6.7.1.

ISOLATED

public static final ClusterTypes.ClusterState ISOLATED

All three nodes are isolated from each other. This constant field was added in vSphere API 6.7.1.

Method Detail

values

public static ClusterTypes.ClusterState[] 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.ClusterState but is not pre-defined.

Returns:

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

valueOf

public static ClusterTypes.ClusterState 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.ClusterState 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.ClusterState.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.ClusterState.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.ClusterState.Values._UNKNOWN enum constant is returned.

The native Java enum is ClusterTypes.ClusterState.Values.

Returns:

The Java enum constant. Never null.