Package software.amazon.awssdk.services.kinesis.model

Class GetRecordsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kinesis.model.GetRecordsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetRecordsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

Represents the input for GetRecords.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRecordsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetRecordsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
Integer	limit()	The maximum number of records to return.
static Class<? extends GetRecordsRequest.Builder>	serializableBuilderClass()
String	shardIterator()	The position in the shard from which you want to start sequentially reading data records.
GetRecordsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

shardIterator

public 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:

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.

limit

public 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:

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.

toBuilder

public GetRecordsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

Returns:

a builder for type T

builder

public static GetRecordsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetRecordsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object