com.vmware.snapservice.tasks

Class Status

java.lang.Object

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

com.vmware.snapservice.tasks.Status

All Implemented Interfaces:

java.io.Serializable

public final class Status
extends com.vmware.vapi.bindings.ApiEnumeration<Status>

The Status enumeration class defines the status values that can be reported for an operation.

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	BLOCKED The operation is blocked.
static Status	FAILED The operation failed.
static Status	PENDING The operation is in pending state.
static Status	RUNNING The operation is in progress.
static Status	SUCCEEDED The operation completed successfully.

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

PENDING

public static final Status PENDING

The operation is in pending state.

RUNNING

public static final Status RUNNING

The operation is in progress.

BLOCKED

public static final Status BLOCKED

The operation is blocked.

The operation could be blocked if the system is waiting for resources to be available to perform the operation.

SUCCEEDED

public static final Status SUCCEEDED

The operation completed successfully.

FAILED

public static final Status FAILED

The operation 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.