com.amazonaws.services.kinesis.producer

Class UserRecordResult

java.lang.Object

com.amazonaws.services.kinesis.producer.UserRecordResult

public class UserRecordResult
extends Object

The result of a KinesisProducer.addUserRecord(java.lang.String, java.lang.String, java.nio.ByteBuffer) operation. If successful, the shard id and sequence number assigned by the backend are provided. A list of Attempts is also provided with details about each attempt made.

Author:

chaodeng

See Also:

Attempt

Constructor Summary

Constructors

Constructor and Description
UserRecordResult(List<Attempt> attempts, String sequenceNumber, String shardId, boolean successful)

Method Summary

Modifier and Type	Method and Description
protected static UserRecordResult	fromProtobufMessage(com.amazonaws.services.kinesis.producer.protobuf.Messages.PutRecordResult r)
List<Attempt>	getAttempts()
String	getSequenceNumber()
String	getShardId()
boolean	isSuccessful()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserRecordResult

public UserRecordResult(List<Attempt> attempts,
                        String sequenceNumber,
                        String shardId,
                        boolean successful)

Method Detail

getAttempts

public List<Attempt> getAttempts()

Returns:

List of Attempts, in the order they were made.

getSequenceNumber

public String getSequenceNumber()

Returns:

The sequence number assigned by the backend to this record. Multiple records may have the same sequence number if aggregation is enabled. Will be null if the put failed.

getShardId

public String getShardId()

Returns:

Shard ID returned by the backend. The record was written to this shard. Will be null if the put failed.

isSuccessful

public boolean isSuccessful()

Returns:

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

fromProtobufMessage

protected static UserRecordResult fromProtobufMessage(com.amazonaws.services.kinesis.producer.protobuf.Messages.PutRecordResult r)