com.vmware.content.library.item.updatesession

Class PreviewInfo.State

java.lang.Object

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

com.vmware.content.library.item.updatesession.PreviewInfo.State

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

PreviewInfo

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

The State enumeration class defines the state of the update session's preview. This enumeration was added in vSphere API 6.8.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PreviewInfo.State	AVAILABLE Preview is available for this update session.
static PreviewInfo.State	NOT_APPLICABLE Preview is not possible for this update session.
static PreviewInfo.State	PREPARING A preview is being prepared for the files currently in the update session.
static PreviewInfo.State	UNAVAILABLE There are no files in the update session OR a preview is not possible for the files currently in the update session.

Method Summary

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

UNAVAILABLE

public static final PreviewInfo.State UNAVAILABLE

There are no files in the update session OR a preview is not possible for the files currently in the update session. However, preview may be possible after metadata files such as OVF descriptor are added to the session. In this case the state will transition to PREPARING. This constant field was added in vSphere API 6.8.

NOT_APPLICABLE

public static final PreviewInfo.State NOT_APPLICABLE

Preview is not possible for this update session. This state is reached when there are no metadata files in the update session and user invokes a session complete operation. This constant field was added in vSphere API 6.8.

PREPARING

public static final PreviewInfo.State PREPARING

A preview is being prepared for the files currently in the update session. This state is reached when the applicable metadata files are added to the update session but their content is not fully uploaded yet. For OVF item type, this state indicates that the OVF descriptor file is currently being uploaded. This constant field was added in vSphere API 6.8.

AVAILABLE

public static final PreviewInfo.State AVAILABLE

Preview is available for this update session. It is possible to review certificate details and warnings, if any. This state is reached when the applicable metadata files in the session have been fully uploaded. This constant field was added in vSphere API 6.8.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is PreviewInfo.State.Values.

Returns:

The Java enum constant. Never null.