com.vmware.content.library.item

Class UpdateSessionModel.State

java.lang.Object

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

com.vmware.content.library.item.UpdateSessionModel.State

All Implemented Interfaces:

Serializable

Enclosing class:

UpdateSessionModel

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

The state of an update session.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static UpdateSessionModel.State	ACTIVE The session is currently active.
static UpdateSessionModel.State	CANCELED The session has been canceled.
static UpdateSessionModel.State	DONE The session is done and all its effects are now visible.
static UpdateSessionModel.State	ERROR There was an error during the session.

Method Summary

Methods

Modifier and Type	Method and Description
UpdateSessionModel.State.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static UpdateSessionModel.State	valueOf(String name) Returns the enumeration constant for the specified name.
static UpdateSessionModel.State[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

equals, hashCode, name, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ACTIVE

public static final UpdateSessionModel.State ACTIVE

The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.

DONE

public static final UpdateSessionModel.State DONE

The session is done and all its effects are now visible.

ERROR

public static final UpdateSessionModel.State ERROR

There was an error during the session.

CANCELED

public static final UpdateSessionModel.State CANCELED

The session has been canceled.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is UpdateSessionModel.State.Values.

Returns:

The Java enum constant. Never null.