@Generated(value="software.amazon.awssdk:codegen") public 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() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
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() |
copy
public List<Record> records()
The data records retrieved from the shard.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 does not return any more data.
null
, the shard has been closed and the requested iterator does not return any more data.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 that record processing is caught up, and there are no new records to process at this moment.
public GetRecordsResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetRecordsResponse.Builder,GetRecordsResponse>
toBuilder
in class AwsResponse
public static GetRecordsResponse.Builder builder()
public static Class<? extends GetRecordsResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.