com.vmware.esx.settings

Class Status

java.lang.Object

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

com.vmware.esx.settings.Status

All Implemented Interfaces:

java.io.Serializable

public final class Status
extends ApiEnumeration<Status>

The Status enumeration class defines the status result for a particular check.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Status	ERROR The check indicates an error.
static Status	OK The check indicates a success.
static Status	RETRY The check failed because of an intermittent error, for example a service is overloaded.
static Status	TIMEOUT The check did not return in a timely manner.
static Status	WARNING The check indicates a warning.

Method Summary

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

The check indicates a success.

WARNING

public static final Status WARNING

The check indicates a warning.

TIMEOUT

public static final Status TIMEOUT

The check did not return in a timely manner.

ERROR

public static final Status ERROR

The check indicates an error.

RETRY

public static final Status RETRY

The check failed because of an intermittent error, for example a service is overloaded. The client can choose to retry the health check before considering the check as failed.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is Status.Values.

Returns:

The Java enum constant. Never null.