com.vmware.esx.settings.clusters.configuration

Class HostStatus.Status

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<HostStatus.Status>

com.vmware.esx.settings.clusters.configuration.HostStatus.Status

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

HostStatus

public static final class HostStatus.Status
extends ApiEnumeration<HostStatus.Status>

The Status enumeration class contains the possible different status codes that can be returned while trying to perform an operation on the hosts within the cluster. This enumeration was added in vSphere API 8.0.1.0.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostStatus.Status.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static HostStatus.Status	CANCELED The method was canceled.
static HostStatus.Status	ERROR The method encountered an unspecified error.
static HostStatus.Status	OK The method completed successfully.
static HostStatus.Status	PENDING The method is pending.
static HostStatus.Status	RETRY_PENDING The method is pending a retry.
static HostStatus.Status	RUNNING The method is in progress.
static HostStatus.Status	SKIPPED The method was skipped.
static HostStatus.Status	TIMED_OUT The method timed out.

Method Summary

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

OK

public static final HostStatus.Status OK

The method completed successfully. This constant field was added in vSphere API 8.0.1.0.

PENDING

public static final HostStatus.Status PENDING

The method is pending. This constant field was added in vSphere API 8.0.1.0.

RUNNING

public static final HostStatus.Status RUNNING

The method is in progress. This constant field was added in vSphere API 8.0.1.0.

RETRY_PENDING

public static final HostStatus.Status RETRY_PENDING

The method is pending a retry. This constant field was added in vSphere API 8.0.1.0.

SKIPPED

public static final HostStatus.Status SKIPPED

The method was skipped. This constant field was added in vSphere API 8.0.1.0.

CANCELED

public static final HostStatus.Status CANCELED

The method was canceled. This constant field was added in vSphere API 8.0.1.0.

TIMED_OUT

public static final HostStatus.Status TIMED_OUT

The method timed out. This constant field was added in vSphere API 8.0.1.0.

ERROR

public static final HostStatus.Status ERROR

The method encountered an unspecified error. This constant field was added in vSphere API 8.0.1.0.

Method Detail

values

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

Returns:

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

valueOf

public static HostStatus.Status 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 HostStatus.Status will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the HostStatus.Status.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 HostStatus.Status.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 HostStatus.Status.Values._UNKNOWN enum constant is returned.

The native Java enum is HostStatus.Status.Values.

Returns:

The Java enum constant. Never null.