Class GetRecordsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.kinesis.model.GetRecordsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class GetRecordsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for GetRecords.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description GetRecordsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetRecordsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Integer
getLimit()
The maximum number of records to return.String
getShardIterator()
The position in the shard from which you want to start sequentially reading data records.int
hashCode()
void
setLimit(Integer limit)
The maximum number of records to return.void
setShardIterator(String shardIterator)
The position in the shard from which you want to start sequentially reading data records.String
toString()
Returns a string representation of this object; useful for testing and debugging.GetRecordsRequest
withLimit(Integer limit)
The maximum number of records to return.GetRecordsRequest
withShardIterator(String shardIterator)
The position in the shard from which you want to start sequentially reading data records.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setShardIterator
public void setShardIterator(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.
- 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.
-
getShardIterator
public 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.
- 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.
-
withShardIterator
public GetRecordsRequest withShardIterator(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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
public void setLimit(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
.- 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 throwsInvalidArgumentException
.
-
getLimit
public 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
.- 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
.
-
withLimit
public GetRecordsRequest withLimit(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
.- 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 throwsInvalidArgumentException
.- 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public GetRecordsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-