Package com.amazonaws.event
Enum ProgressEventType
- All Implemented Interfaces:
Serializable
,Comparable<ProgressEventType>
,java.lang.constant.Constable
An enumeration that denotes various types of progress event.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated.Event indicating that a client request has failed (after retries have been conducted).Event indicating that a failed request is detected as retryable and is ready for the next retry.Event indicating that the client has started sending the AWS API request.Event indicating that the client has received a successful service response and has finished parsing the response data.Event indicating that the client has finished sending the HTTP request.Event indicating that the HTTP request content is reset, which may or may not be caused by the retry of the request.Event indicating that the client has started sending the HTTP request.Event indicating that the client has finished reading the HTTP response.Event indicating that the HTTP response content is reset.Event indicating that the client has started reading the HTTP response.Used to indicate the number of bytes to be sent to AWS.Event of the content length to be sent in a request.Used to indicate the number of bytes discarded after being received from AWS.Used to indicate the number of bytes received from AWS.Event of the content length received in a response. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if this even type is associated with some number of bytes; false otherwise.boolean
Returns true if this event type is related to the execution of a single http request-response to AWS; false otherwise.boolean
Returns true if this event type is a transfer event, which may involve multiple request cycle events.static ProgressEventType
Returns the enum constant of this type with the specified name.static ProgressEventType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
BYTE_TRANSFER_EVENT
Deprecated.A general byte transfer event that happens during sending a request or reading a response. -
REQUEST_CONTENT_LENGTH_EVENT
Event of the content length to be sent in a request. -
RESPONSE_CONTENT_LENGTH_EVENT
Event of the content length received in a response. -
REQUEST_BYTE_TRANSFER_EVENT
Used to indicate the number of bytes to be sent to AWS. -
RESPONSE_BYTE_TRANSFER_EVENT
Used to indicate the number of bytes received from AWS. -
RESPONSE_BYTE_DISCARD_EVENT
Used to indicate the number of bytes discarded after being received from AWS. -
CLIENT_REQUEST_STARTED_EVENT
Event indicating that the client has started sending the AWS API request. This type of event is guaranteed to be only fired once during a request-response cycle, even when the request is retried. -
HTTP_REQUEST_STARTED_EVENT
Event indicating that the client has started sending the HTTP request. The request progress listener will be notified of multiple instances of this type of event if the request gets retried. -
HTTP_REQUEST_COMPLETED_EVENT
Event indicating that the client has finished sending the HTTP request. The request progress listener will be notified of multiple instances of this type of event if the request gets retried. -
HTTP_REQUEST_CONTENT_RESET_EVENT
Event indicating that the HTTP request content is reset, which may or may not be caused by the retry of the request. -
CLIENT_REQUEST_RETRY_EVENT
Event indicating that a failed request is detected as retryable and is ready for the next retry. -
HTTP_RESPONSE_STARTED_EVENT
Event indicating that the client has started reading the HTTP response. The request progress listener will be notified of this event only if the client receives a successful service response (i.e. 2XX status code). -
HTTP_RESPONSE_COMPLETED_EVENT
Event indicating that the client has finished reading the HTTP response. The request progress listener will be notified of this event only if the client receives a successful service response (i.e. 2XX status code). -
HTTP_RESPONSE_CONTENT_RESET_EVENT
Event indicating that the HTTP response content is reset. -
CLIENT_REQUEST_SUCCESS_EVENT
Event indicating that the client has received a successful service response and has finished parsing the response data. -
CLIENT_REQUEST_FAILED_EVENT
Event indicating that a client request has failed (after retries have been conducted). -
TRANSFER_PREPARING_EVENT
-
TRANSFER_STARTED_EVENT
-
TRANSFER_COMPLETED_EVENT
-
TRANSFER_FAILED_EVENT
-
TRANSFER_CANCELED_EVENT
-
TRANSFER_PART_STARTED_EVENT
-
TRANSFER_PART_COMPLETED_EVENT
-
TRANSFER_PART_FAILED_EVENT
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
isTransferEvent
public boolean isTransferEvent()Returns true if this event type is a transfer event, which may involve multiple request cycle events.- See Also:
-
isRequestCycleEvent
public boolean isRequestCycleEvent()Returns true if this event type is related to the execution of a single http request-response to AWS; false otherwise. -
isByteCountEvent
public boolean isByteCountEvent()Returns true if this even type is associated with some number of bytes; false otherwise.
-