com.vmware.content.library.item

Class TransferStatus

java.lang.Object

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

com.vmware.content.library.item.TransferStatus

All Implemented Interfaces:

Serializable

public final class TransferStatus
extends ApiEnumeration<TransferStatus>

The TransferStatus enumeration class defines the transfer state of a file.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static TransferStatus	ERROR Indicates that there was an error transferring or validating the file.
static TransferStatus	READY Indicates that the file has been fully transferred and is ready to be used.
static TransferStatus	TRANSFERRING Indicates that data is being transferred to the file.
static TransferStatus	VALIDATING Indicates that the file is being validated (checksum, type adapters).
static TransferStatus	WAITING_FOR_TRANSFER Indicates that a file has been defined for a library item and its content needs to be uploaded.

Method Summary

Methods

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

WAITING_FOR_TRANSFER

public static final TransferStatus WAITING_FOR_TRANSFER

Indicates that a file has been defined for a library item and its content needs to be uploaded.

TRANSFERRING

public static final TransferStatus TRANSFERRING

Indicates that data is being transferred to the file.

READY

public static final TransferStatus READY

Indicates that the file has been fully transferred and is ready to be used.

VALIDATING

public static final TransferStatus VALIDATING

Indicates that the file is being validated (checksum, type adapters).

ERROR

public static final TransferStatus ERROR

Indicates that there was an error transferring or validating the file.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is TransferStatus.Values.

Returns:

The Java enum constant. Never null.