com.vmware.appliance

Class UpdateTypes.State

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<UpdateTypes.State>

com.vmware.appliance.UpdateTypes.State

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

UpdateTypes

public static final class UpdateTypes.State
extends ApiEnumeration<UpdateTypes.State>

The State enumeration class defines the various states the appliance update 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	UpdateTypes.State.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static UpdateTypes.State	INSTALL_FAILED The appliance update failed and cannot recover.
static UpdateTypes.State	INSTALL_IN_PROGRESS The appliance update is in progress of installing an update.
static UpdateTypes.State	ROLLBACK_IN_PROGRESS The appliance update failed and recovery is in progress.
static UpdateTypes.State	STAGE_IN_PROGRESS The appliance update is in progress of downloading an update.
static UpdateTypes.State	UP_TO_DATE The appliance is up to date.
static UpdateTypes.State	UPDATES_PENDING A new update is available.

Method Summary

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

UP_TO_DATE

public static final UpdateTypes.State UP_TO_DATE

The appliance is up to date. This constant field was added in vSphere API 6.7.

UPDATES_PENDING

public static final UpdateTypes.State UPDATES_PENDING

A new update is available. This constant field was added in vSphere API 6.7.

STAGE_IN_PROGRESS

public static final UpdateTypes.State STAGE_IN_PROGRESS

The appliance update is in progress of downloading an update. This constant field was added in vSphere API 6.7.

INSTALL_IN_PROGRESS

public static final UpdateTypes.State INSTALL_IN_PROGRESS

The appliance update is in progress of installing an update. This constant field was added in vSphere API 6.7.

INSTALL_FAILED

public static final UpdateTypes.State INSTALL_FAILED

The appliance update failed and cannot recover. This constant field was added in vSphere API 6.7.

ROLLBACK_IN_PROGRESS

public static final UpdateTypes.State ROLLBACK_IN_PROGRESS

The appliance update failed and recovery is in progress. This constant field was added in vSphere API 6.7.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is UpdateTypes.State.Values.

Returns:

The Java enum constant. Never null.