com.amazonaws.services.kinesis.clientlibrary.types

Class ProcessRecordsInput

java.lang.Object

com.amazonaws.services.kinesis.clientlibrary.types.ProcessRecordsInput

public class ProcessRecordsInput
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ProcessRecordsInput() Default constructor.

Method Summary

Modifier and Type	Method and Description
IRecordProcessorCheckpointer	getCheckpointer() Get Checkpointer.
Long	getMillisBehindLatest() Get milliseconds behind latest.
List<com.amazonaws.services.kinesis.model.Record>	getRecords() Get records.
Duration	getTimeSpentInCache()
ProcessRecordsInput	withCacheEntryTime(Instant cacheEntryTime)
ProcessRecordsInput	withCacheExitTime(Instant cacheExitTime)
ProcessRecordsInput	withCheckpointer(IRecordProcessorCheckpointer checkpointer) Set Checkpointer.
ProcessRecordsInput	withMillisBehindLatest(Long millisBehindLatest) Set milliseconds behind latest.
ProcessRecordsInput	withRecords(List<com.amazonaws.services.kinesis.model.Record> records) Set records.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessRecordsInput

public ProcessRecordsInput()

Default constructor.

Method Detail

getRecords

public List<com.amazonaws.services.kinesis.model.Record> getRecords()

Get records.

Returns:

Data records to be processed

withRecords

public ProcessRecordsInput withRecords(List<com.amazonaws.services.kinesis.model.Record> records)

Set records.

Parameters:

records - Data records to be processed

Returns:

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

getCheckpointer

public IRecordProcessorCheckpointer getCheckpointer()

Get Checkpointer.

Returns:

RecordProcessor should use this instance to checkpoint their progress.

withCheckpointer

public ProcessRecordsInput withCheckpointer(IRecordProcessorCheckpointer checkpointer)

Set Checkpointer.

Parameters:

checkpointer - RecordProcessor should use this instance to checkpoint their progress.

Returns:

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

getMillisBehindLatest

public Long getMillisBehindLatest()

Get milliseconds behind latest.

Returns:

The number of milliseconds this batch of records is from the tip of the stream, indicating how far behind current time the record processor is.

withMillisBehindLatest

public ProcessRecordsInput withMillisBehindLatest(Long millisBehindLatest)

Set milliseconds behind latest.

Parameters:

millisBehindLatest - The number of milliseconds this batch of records is from the tip of the stream, indicating how far behind current time the record processor is.

Returns:

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

withCacheEntryTime

public ProcessRecordsInput withCacheEntryTime(Instant cacheEntryTime)

withCacheExitTime

public ProcessRecordsInput withCacheExitTime(Instant cacheExitTime)

getTimeSpentInCache

public Duration getTimeSpentInCache()