Package software.amazon.awssdk.services.kinesis.model

Interface GetRecordsResponse.Builder

All Superinterfaces:

CopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>, SdkBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Enclosing class:

GetRecordsResponse

public static interface GetRecordsResponse.Builder
extends CopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Method Summary

Modifier and Type	Method	Description
GetRecordsResponse.Builder	millisBehindLatest(Long millisBehindLatest)	The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is.
GetRecordsResponse.Builder	nextShardIterator(String nextShardIterator)	The next position in the shard from which to start sequentially reading data records.
GetRecordsResponse.Builder	records(Collection<Record> records)	The data records retrieved from the shard.
GetRecordsResponse.Builder	records(Record... records)	The data records retrieved from the shard.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

records

GetRecordsResponse.Builder records(Collection<Record> records)

The data records retrieved from the shard.

Parameters:

records - The data records retrieved from the shard.

Returns:

Returns a reference to this object so that method calls can be chained together.

records

GetRecordsResponse.Builder records(Record... records)

The data records retrieved from the shard.

NOTE: This method appends the values to the existing list (if any). Use #setRecords(java.util.Collection) or #withRecords(java.util.Collection) if you want to override the existing values.

Parameters:

records - The data records retrieved from the shard.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextShardIterator

GetRecordsResponse.Builder nextShardIterator(String nextShardIterator)

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

Parameters:

nextShardIterator - The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

Returns:

Returns a reference to this object so that method calls can be chained together.

millisBehindLatest

GetRecordsResponse.Builder millisBehindLatest(Long millisBehindLatest)

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

Parameters:

millisBehindLatest - The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

Returns:

Returns a reference to this object so that method calls can be chained together.