com.amazonaws.services.kinesis.producer

Class Attempt

java.lang.Object

com.amazonaws.services.kinesis.producer.Attempt

public class Attempt
extends Object

Represents one attempt at writing a record to the backend. The attempt may or may not be successful. If unsuccessful, an error code and error message are provided. In addition, data about latency are also provided. Each record may have multiple attempts.

Author:

chaodeng

See Also:

UserRecordResult

Constructor Summary

Constructors

Constructor and Description
Attempt(int delay, int duration, String errorMessage, String errorCode, boolean success)

Method Summary

Modifier and Type	Method and Description
protected static Attempt	fromProtobufMessage(com.amazonaws.services.kinesis.producer.protobuf.Messages.Attempt a)
int	getDelay()
int	getDuration()
String	getErrorCode()
String	getErrorMessage()
boolean	isSuccessful()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Attempt

public Attempt(int delay,
               int duration,
               String errorMessage,
               String errorCode,
               boolean success)

Method Detail

getDelay

public int getDelay()

Returns:

Delay in milliseconds between the start of this attempt and the previous attempt. If this is the first attempt, then returns the delay between the message reaching the daemon and the first attempt.

getDuration

public int getDuration()

Returns:

Duration of the attempt. Mainly consists of network and server latency, but also includes processing overhead within the daemon.

getErrorMessage

public String getErrorMessage()

Returns:

Error message associated with this attempt. Null if no error (i.e. successful).

getErrorCode

public String getErrorCode()

Returns:

Error code associated with this attempt. Null if no error (i.e. successful).

isSuccessful

public boolean isSuccessful()

Returns:

Whether the attempt was successful. If true, then the record has been confirmed by the backend.

fromProtobufMessage

protected static Attempt fromProtobufMessage(com.amazonaws.services.kinesis.producer.protobuf.Messages.Attempt a)