com.vmware.vcenter.vcha

Class ClusterTypes.ClusterMode

java.lang.Object

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

com.vmware.vcenter.vcha.ClusterTypes.ClusterMode

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ClusterTypes

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static ClusterTypes.ClusterMode	DISABLED VCHA Cluster is disabled.
static ClusterTypes.ClusterMode	ENABLED VCHA Cluster is enabled.
static ClusterTypes.ClusterMode	MAINTENANCE VCHA Cluster is in maintenance mode.

Method Summary

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

ENABLED

public static final ClusterTypes.ClusterMode ENABLED

VCHA Cluster is enabled. State replication between the Active and Passive node is enabled and automatic failover is allowed. This constant field was added in vSphere API 6.7.1.

DISABLED

public static final ClusterTypes.ClusterMode DISABLED

VCHA Cluster is disabled. State replication between the Active and Passive node is disabled and automatic failover is not allowed. This constant field was added in vSphere API 6.7.1.

MAINTENANCE

public static final ClusterTypes.ClusterMode MAINTENANCE

VCHA Cluster is in maintenance mode. State replication between the Active and Passive node is enabled but automatic failover is not allowed. This constant field was added in vSphere API 6.7.1.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ClusterTypes.ClusterMode.Values.

Returns:

The Java enum constant. Never null.