com.amazonaws.mobileconnectors.s3.transferutility

Enum TransferState

java.lang.Object

java.lang.Enum<TransferState>

com.amazonaws.mobileconnectors.s3.transferutility.TransferState

All Implemented Interfaces:

Serializable, Comparable<TransferState>

public enum TransferState
extends Enum<TransferState>

The current state of a transfer. A transfer is initially in WAITING state when added. It will turn into IN_PROGRESS once it starts. Customers can pause or cancel the transfer when needed and turns it into PAUSED or CANCELED state respectively. Finally the transfer will either succeed as COMPLETED or fail as FAILED. WAITING_FOR_NETWORK state may kick in for an active transfer when network is lost. The other enum values are internal use only.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED This state represents a transfer that is canceled
COMPLETED This state represents a transfer that is completed
FAILED This state represents a transfer that has failed
IN_PROGRESS This state represents a transfer that is currently uploading or downloading data
PART_COMPLETED This state represents a transfer that is a completed part of a multi-part upload.
PAUSED This state represents a transfer that is paused
PENDING_CANCEL This state represents a transfer that has been requested to cancel, but the service processing transfers has not yet fulfilled this request.
PENDING_NETWORK_DISCONNECT This state represents a transfer that has been requested to pause by the client because the network has been loss, but the service processing transfers has not yet fulfilled this request.
PENDING_PAUSE This state represents a transfer that has been requested to pause by the client, but the service processing transfers has not yet fulfilled this request.
RESUMED_WAITING This state represents a transfer that has been resumed and queued for execution, but has not started to actively transfer data
UNKNOWN This is an internal value used to detect if the current transfer is in an unknown state
WAITING This state represents a transfer that has been queued, but has not yet started
WAITING_FOR_NETWORK This state represents a transfer that is currently on hold, waiting for the network to become available

Method Summary

Modifier and Type	Method and Description
static TransferState	getState(String stateAsString) Returns the transfer state from string
static TransferState	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransferState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WAITING

public static final TransferState WAITING

This state represents a transfer that has been queued, but has not yet started

IN_PROGRESS

public static final TransferState IN_PROGRESS

This state represents a transfer that is currently uploading or downloading data

PAUSED

public static final TransferState PAUSED

This state represents a transfer that is paused

RESUMED_WAITING

public static final TransferState RESUMED_WAITING

This state represents a transfer that has been resumed and queued for execution, but has not started to actively transfer data

COMPLETED

public static final TransferState COMPLETED

This state represents a transfer that is completed

CANCELED

public static final TransferState CANCELED

This state represents a transfer that is canceled

FAILED

public static final TransferState FAILED

This state represents a transfer that has failed

WAITING_FOR_NETWORK

public static final TransferState WAITING_FOR_NETWORK

This state represents a transfer that is currently on hold, waiting for the network to become available

PART_COMPLETED

public static final TransferState PART_COMPLETED

This state represents a transfer that is a completed part of a multi-part upload. This state is primarily used internally and there should be no need to use this state.

PENDING_CANCEL

public static final TransferState PENDING_CANCEL

This state represents a transfer that has been requested to cancel, but the service processing transfers has not yet fulfilled this request. This state is primarily used internally and there should be no need to use this state.

PENDING_PAUSE

public static final TransferState PENDING_PAUSE

This state represents a transfer that has been requested to pause by the client, but the service processing transfers has not yet fulfilled this request. This state is primarily used internally and there should be no need to use this state.

PENDING_NETWORK_DISCONNECT

public static final TransferState PENDING_NETWORK_DISCONNECT

This state represents a transfer that has been requested to pause by the client because the network has been loss, but the service processing transfers has not yet fulfilled this request. This state is primarily used internally and there should be no need to use this state.

UNKNOWN

public static final TransferState UNKNOWN

This is an internal value used to detect if the current transfer is in an unknown state

Method Detail

values

public static TransferState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransferState c : TransferState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransferState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getState

public static TransferState getState(String stateAsString)

Returns the transfer state from string

Parameters:

stateAsString - state of the transfer represented as string.

Returns:

the TransferState