GetRecordsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.GetRecordsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetRecordsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Gets data records from a Kinesis data stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next five seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next one second throw ProvisionedThroughputExceededException. GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetRecordsRequest()

Constructors
Constructor and Description
`GetRecordsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getLimit()` The maximum number of records to return.
`java.lang.String`	`getShardIterator()` The position in the shard from which you want to start sequentially reading data records.
`int`	`hashCode()`
`void`	`setLimit(java.lang.Integer limit)` The maximum number of records to return.
`void`	`setShardIterator(java.lang.String shardIterator)` The position in the shard from which you want to start sequentially reading data records.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetRecordsRequest`	`withLimit(java.lang.Integer limit)` The maximum number of records to return.
`GetRecordsRequest`	`withShardIterator(java.lang.String shardIterator)` The position in the shard from which you want to start sequentially reading data records.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetRecordsRequest
```
public GetRecordsRequest()
```
- Method Detail
  - getShardIterator
```
public java.lang.String getShardIterator()
```
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    
    Constraints:
    Length: 1 - 512
    
    Returns:
    
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
  - setShardIterator
```
public void setShardIterator(java.lang.String shardIterator)
```
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    shardIterator -
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
  - withShardIterator
```
public GetRecordsRequest withShardIterator(java.lang.String shardIterator)
```
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    shardIterator -
    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public java.lang.Integer getLimit()
```
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
    
    Constraints:
    Range: 1 - 10000
    
    Returns:
    
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
  - setLimit
```
public void setLimit(java.lang.Integer limit)
```
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
    
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    limit -
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException .
  - withLimit
```
public GetRecordsRequest withLimit(java.lang.Integer limit)
```
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    limit -
    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException .
    
    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

Class GetRecordsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetRecordsRequest

Method Detail

getShardIterator

setShardIterator

withShardIterator

getLimit

setLimit

withLimit

toString

hashCode

equals