com.amazonaws.services.kinesis.model

Class GetRecordsResult

java.lang.Object

com.amazonaws.services.kinesis.model.GetRecordsResult

All Implemented Interfaces:

java.io.Serializable

public class GetRecordsResult
extends java.lang.Object
implements java.io.Serializable

Represents the output for GetRecords.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetRecordsResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.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.
java.lang.String	getNextShardIterator() The next position in the shard from which to start sequentially reading data records.
java.util.List<Record>	getRecords() The data records retrieved from the shard.
int	hashCode()
void	setMillisBehindLatest(java.lang.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(java.lang.String nextShardIterator) The next position in the shard from which to start sequentially reading data records.
void	setRecords(java.util.Collection<Record> records) The data records retrieved from the shard.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetRecordsResult	withMillisBehindLatest(java.lang.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(java.lang.String nextShardIterator) The next position in the shard from which to start sequentially reading data records.
GetRecordsResult	withRecords(java.util.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetRecordsResult

public GetRecordsResult()

Method Detail

getRecords

public java.util.List<Record> getRecords()

The data records retrieved from the shard.

Returns:

The data records retrieved from the shard.

setRecords

public void setRecords(java.util.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.

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

Parameters:

records -

The data records retrieved from the shard.

Returns:

A reference to this updated object so that method calls can be chained together.

withRecords

public GetRecordsResult withRecords(java.util.Collection<Record> records)

The data records retrieved from the shard.

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

Parameters:

records -

The data records retrieved from the shard.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextShardIterator

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

Constraints:
Length: 1 - 512

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.

setNextShardIterator

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

Constraints:
Length: 1 - 512

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.

withNextShardIterator

public GetRecordsResult withNextShardIterator(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 512

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:

A reference to this updated object so that method calls can be chained together.

getMillisBehindLatest

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

Constraints:
Range: 0 -

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.

setMillisBehindLatest

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

Constraints:
Range: 0 -

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.

withMillisBehindLatest

public GetRecordsResult withMillisBehindLatest(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object