@Generated(value="software.amazon.awssdk:codegen") public final class GetRecordsResponse extends KinesisResponse implements ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
Represents the output for GetRecords.
Modifier and Type | Class and Description |
---|---|
static interface |
GetRecordsResponse.Builder |
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.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasRecords()
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.
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.
null
, the shard has been closed and the requested iterator does not return any more data.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.
public final boolean hasChildShards()
public final List<ChildShard> childShards()
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.
public GetRecordsResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
toBuilder
in class AwsResponse
public static GetRecordsResponse.Builder builder()
public static Class<? extends GetRecordsResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2021. All rights reserved.