org.apache.hadoop.fs.s3a.impl

Enum ProgressListenerEvent

java.lang.Object

java.lang.Enum<ProgressListenerEvent>

org.apache.hadoop.fs.s3a.impl.ProgressListenerEvent

All Implemented Interfaces:

Serializable, Comparable<ProgressListenerEvent>

public enum ProgressListenerEvent
extends Enum<ProgressListenerEvent>

Enum for progress listener events. Some are used in the S3ABlockOutputStream class to manage progress; others are to assist testing.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE_EVENT Stream has been closed.
PUT_COMPLETED_EVENT PUT operation completed successfully.
PUT_FAILED_EVENT PUT operation was interrupted.
PUT_INTERRUPTED_EVENT PUT operation was interrupted.
PUT_STARTED_EVENT A PUT operation was started.
REQUEST_BYTE_TRANSFER_EVENT Bytes were transferred.
TRANSFER_MULTIPART_ABORTED_EVENT A multipart upload was aborted.
TRANSFER_MULTIPART_COMPLETED_EVENT A multipart upload was successfully.
TRANSFER_MULTIPART_INITIATED_EVENT A multipart upload was initiated.
TRANSFER_PART_ABORTED_EVENT An upload of a part of a multipart upload was abported.
TRANSFER_PART_COMPLETED_EVENT An upload of a part of a multipart upload was completed.
TRANSFER_PART_FAILED_EVENT An upload of a part of a multipart upload failed.
TRANSFER_PART_STARTED_EVENT An upload of a part of a multipart upload was started.
TRANSFER_PART_SUCCESS_EVENT An upload of a part of a multipart upload was completed successfully.

Method Summary

Modifier and Type	Method and Description
static ProgressListenerEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgressListenerEvent[]	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

CLOSE_EVENT

public static final ProgressListenerEvent CLOSE_EVENT

Stream has been closed.

PUT_COMPLETED_EVENT

public static final ProgressListenerEvent PUT_COMPLETED_EVENT

PUT operation completed successfully.

PUT_INTERRUPTED_EVENT

public static final ProgressListenerEvent PUT_INTERRUPTED_EVENT

PUT operation was interrupted.

PUT_FAILED_EVENT

public static final ProgressListenerEvent PUT_FAILED_EVENT

PUT operation was interrupted.

PUT_STARTED_EVENT

public static final ProgressListenerEvent PUT_STARTED_EVENT

A PUT operation was started.

REQUEST_BYTE_TRANSFER_EVENT

public static final ProgressListenerEvent REQUEST_BYTE_TRANSFER_EVENT

Bytes were transferred.

TRANSFER_MULTIPART_INITIATED_EVENT

public static final ProgressListenerEvent TRANSFER_MULTIPART_INITIATED_EVENT

A multipart upload was initiated.

TRANSFER_MULTIPART_ABORTED_EVENT

public static final ProgressListenerEvent TRANSFER_MULTIPART_ABORTED_EVENT

A multipart upload was aborted.

TRANSFER_MULTIPART_COMPLETED_EVENT

public static final ProgressListenerEvent TRANSFER_MULTIPART_COMPLETED_EVENT

A multipart upload was successfully.

TRANSFER_PART_STARTED_EVENT

public static final ProgressListenerEvent TRANSFER_PART_STARTED_EVENT

An upload of a part of a multipart upload was started.

TRANSFER_PART_COMPLETED_EVENT

public static final ProgressListenerEvent TRANSFER_PART_COMPLETED_EVENT

An upload of a part of a multipart upload was completed. This does not indicate the upload was successful.

TRANSFER_PART_SUCCESS_EVENT

public static final ProgressListenerEvent TRANSFER_PART_SUCCESS_EVENT

An upload of a part of a multipart upload was completed successfully.

TRANSFER_PART_ABORTED_EVENT

public static final ProgressListenerEvent TRANSFER_PART_ABORTED_EVENT

An upload of a part of a multipart upload was abported.

TRANSFER_PART_FAILED_EVENT

public static final ProgressListenerEvent TRANSFER_PART_FAILED_EVENT

An upload of a part of a multipart upload failed.

Method Detail

values

public static ProgressListenerEvent[] 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 (ProgressListenerEvent c : ProgressListenerEvent.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProgressListenerEvent 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