com.amazonaws.services.kinesis.model

Class GetRecordsResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kinesis.model.GetRecordsResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetRecordsResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents the output for GetRecords.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetRecordsResult()

Method Summary

Modifier and Type	Method and Description
GetRecordsResult	clone()
boolean	equals(Object obj)
List<ChildShard>	getChildShards() The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.
Long	getMillisBehindLatest() The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is.
String	getNextShardIterator() The next position in the shard from which to start sequentially reading data records.
List<Record>	getRecords() The data records retrieved from the shard.
int	hashCode()
void	setChildShards(Collection<ChildShard> childShards) The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.
void	setMillisBehindLatest(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.
void	setNextShardIterator(String nextShardIterator) The next position in the shard from which to start sequentially reading data records.
void	setRecords(Collection<Record> records) The data records retrieved from the shard.
String	toString() Returns a string representation of this object.
GetRecordsResult	withChildShards(ChildShard... childShards) The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.
GetRecordsResult	withChildShards(Collection<ChildShard> childShards) The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.
GetRecordsResult	withMillisBehindLatest(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.
GetRecordsResult	withNextShardIterator(String nextShardIterator) The next position in the shard from which to start sequentially reading data records.
GetRecordsResult	withRecords(Collection<Record> records) The data records retrieved from the shard.
GetRecordsResult	withRecords(Record... records) The data records retrieved from the shard.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

GetRecordsResult

public GetRecordsResult()

Method Detail

getRecords

public List<Record> getRecords()

The data records retrieved from the shard.

Returns:

The data records retrieved from the shard.

setRecords

public void setRecords(Collection<Record> records)

The data records retrieved from the shard.

Parameters:

records - The data records retrieved from the shard.

withRecords

public GetRecordsResult withRecords(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.

withRecords

public GetRecordsResult withRecords(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.

setNextShardIterator

public void setNextShardIterator(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.

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

getNextShardIterator

public String getNextShardIterator()

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.

withNextShardIterator

public GetRecordsResult withNextShardIterator(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.

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

Returns:

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

setMillisBehindLatest

public void setMillisBehindLatest(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.

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

getMillisBehindLatest

public Long getMillisBehindLatest()

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.

withMillisBehindLatest

public GetRecordsResult withMillisBehindLatest(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.

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

getChildShards

public List<ChildShard> getChildShards()

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Returns:

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

setChildShards

public void setChildShards(Collection<ChildShard> childShards)

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Parameters:

childShards - The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

withChildShards

public GetRecordsResult withChildShards(ChildShard... childShards)

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

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

Parameters:

childShards - The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Returns:

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

withChildShards

public GetRecordsResult withChildShards(Collection<ChildShard> childShards)

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Parameters:

childShards - The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetRecordsResult clone()

Overrides:

clone in class Object