com.amazonaws.services.kinesis.multilang.messages

Class CheckpointMessage

java.lang.Object

com.amazonaws.services.kinesis.multilang.messages.Message

com.amazonaws.services.kinesis.multilang.messages.CheckpointMessage

public class CheckpointMessage
extends Message

A checkpoint message is sent by the client's subprocess to indicate to the kcl processor that it should attempt to checkpoint. The processor sends back a checkpoint message as an acknowledgement that it attempted to checkpoint along with an error message which corresponds to the names of exceptions that a checkpointer can throw.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION The name used for the action field in Message.

Constructor Summary

Constructors

Constructor and Description
CheckpointMessage() Default constructor.
CheckpointMessage(String sequenceNumber, Throwable throwable) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
String	getCheckpoint()
String	getError()
void	setCheckpoint(String checkpoint)
void	setError(String error)

Methods inherited from class com.amazonaws.services.kinesis.multilang.messages.Message

toString

Methods inherited from class java.lang.Object

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

Field Detail

ACTION

public static final String ACTION

The name used for the action field in Message.

See Also:

Constant Field Values

Constructor Detail

CheckpointMessage

public CheckpointMessage()

Default constructor.

CheckpointMessage

public CheckpointMessage(String sequenceNumber,
                         Throwable throwable)

Convenience constructor.

Parameters:

sequenceNumber - The sequence number that this message is about.

throwable - When responding to a client's process, the record processor will add the name of the exception that occurred while attempting to checkpoint if one did occur.

Method Detail

getCheckpoint

public String getCheckpoint()

Returns:

The checkpoint.

getError

public String getError()

Returns:

The error.

setCheckpoint

public void setCheckpoint(String checkpoint)

Parameters:

checkpoint - The checkpoint.

setError

public void setError(String error)

Parameters:

error - The error.