software.amazon.awssdk.services.kinesis.model

Class GetRecordsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kinesis.model.KinesisResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetRecordsResponse
extends KinesisResponse
implements ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Represents the output for GetRecords.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetRecordsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetRecordsResponse.Builder	builder()
List<ChildShard>	childShards() Returns the value of the ChildShards property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChildShards() Returns true if the ChildShards property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasRecords() Returns true if the Records property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetRecordsResponse.Builder>	serializableBuilderClass()
GetRecordsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kinesis.model.KinesisResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasRecords

public final boolean hasRecords()

Returns true if the Records property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

records

public final List<Record> records()

The data records retrieved from the shard.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRecords() to see if a value was sent in this field.

Returns:

The data records retrieved from the shard.

nextShardIterator

public final 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 does 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 does not return any more data.

millisBehindLatest

public final 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 that 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 that record processing is caught up, and there are no new records to process at this moment.

hasChildShards

public final boolean hasChildShards()

Returns true if the ChildShards property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

childShards

public final List<ChildShard> childShards()

Returns the value of the ChildShards property for this object.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasChildShards() to see if a value was sent in this field.

Returns:

The value of the ChildShards property for this object.

toBuilder

public GetRecordsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetRecordsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo