com.amazonaws.services.kinesis.clientlibrary.types

Class ShutdownInput

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.types.ShutdownInput

public class ShutdownInput
extends Object

Container for the parameters to the IRecordProcessor's shutdown method.

Constructor Summary

Constructors

Constructor and Description
ShutdownInput() Default constructor.

Method Summary

Modifier and Type	Method and Description
IRecordProcessorCheckpointer	getCheckpointer() Get Checkpointer.
ShutdownReason	getShutdownReason() Get shutdown reason.
ShutdownInput	withCheckpointer(IRecordProcessorCheckpointer checkpointer) Set the checkpointer.
ShutdownInput	withShutdownReason(ShutdownReason shutdownReason) Set shutdown reason.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutdownInput

public ShutdownInput()

Default constructor.

Method Detail

getShutdownReason

public ShutdownReason getShutdownReason()

Get shutdown reason.

Returns:

Reason for the shutdown (ShutdownReason.TERMINATE indicates the shard is closed and there are no more records to process. Shutdown.ZOMBIE indicates a fail over has occurred).

withShutdownReason

public ShutdownInput withShutdownReason(ShutdownReason shutdownReason)

Set shutdown reason.

Parameters:

shutdownReason - Reason for the shutdown

Returns:

A reference to this updated object so that method calls can be chained together.

getCheckpointer

public IRecordProcessorCheckpointer getCheckpointer()

Get Checkpointer.

Returns:

The checkpointer object that the record processor should use to checkpoint

withCheckpointer

public ShutdownInput withCheckpointer(IRecordProcessorCheckpointer checkpointer)

Set the checkpointer.

Parameters:

checkpointer - The checkpointer object that the record processor should use to checkpoint

Returns:

A reference to this updated object so that method calls can be chained together.