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

Class GetRecordsResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.kinesis.model.GetRecordsResponse

All Implemented Interfaces:

ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

@Generated("software.amazon.awssdk:codegen")
public class GetRecordsResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Represents the output for GetRecords.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRecordsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetRecordsResponse.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
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.
String	nextShardIterator()	The next position in the shard from which to start sequentially reading data records.
List<Record>	records()	The data records retrieved from the shard.
static Class<? extends GetRecordsResponse.Builder>	serializableBuilderClass()
GetRecordsResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

records

public List<Record> records()

The data records retrieved from the shard.

Returns:

The data records retrieved from the shard.

nextShardIterator

public 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.

Returns:

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.

millisBehindLatest

public 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.

Returns:

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.

toBuilder

public GetRecordsResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Returns:

a builder for type T

builder

public static GetRecordsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetRecordsResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object