com.vmware.vcenter.deployment

Class ApplianceState

java.lang.Object

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

com.vmware.vcenter.deployment.ApplianceState

All Implemented Interfaces:

java.io.Serializable

public final class ApplianceState
extends ApiEnumeration<ApplianceState>

The ApplianceState enumeration class defines the various states the vCenter Appliance can be in. This enumeration was added in vSphere API 6.7.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ApplianceState	CONFIG_IN_PROGRESS The appliance is in the process of being configured.
static ApplianceState	CONFIGURED The appliance has been configured.
static ApplianceState	FAILED The appliance configuration has failed.
static ApplianceState	INITIALIZED The appliance is initialized and ready to be configured.
static ApplianceState	NOT_INITIALIZED The appliance is in the process of being initialized and not ready for configuration.
static ApplianceState	QUESTION_RAISED The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration.

Method Summary

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

NOT_INITIALIZED

public static final ApplianceState NOT_INITIALIZED

The appliance is in the process of being initialized and not ready for configuration. This constant field was added in vSphere API 6.7.

INITIALIZED

public static final ApplianceState INITIALIZED

The appliance is initialized and ready to be configured. This constant field was added in vSphere API 6.7.

CONFIG_IN_PROGRESS

public static final ApplianceState CONFIG_IN_PROGRESS

The appliance is in the process of being configured. This constant field was added in vSphere API 6.7.

QUESTION_RAISED

public static final ApplianceState QUESTION_RAISED

The deployment script has raised a question and is waiting for an answer to continue with the appliance configuration. This constant field was added in vSphere API 6.7.

FAILED

public static final ApplianceState FAILED

The appliance configuration has failed. This constant field was added in vSphere API 6.7.

CONFIGURED

public static final ApplianceState CONFIGURED

The appliance has been configured. This constant field was added in vSphere API 6.7.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ApplianceState.Values.

Returns:

The Java enum constant. Never null.