software.amazon.awssdk.services.kinesis.model

Class GetRecordsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

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

Represents the input for GetRecords.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetRecordsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetRecordsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() The maximum number of records to return.
List<SdkField<?>>	sdkFields()
static Class<? extends GetRecordsRequest.Builder>	serializableBuilderClass()
String	shardIterator() The position in the shard from which you want to start sequentially reading data records.
String	streamARN() The ARN of the stream.
GetRecordsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

shardIterator

public final 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 final 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. The default value is 10,000.

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. The default value is 10,000.

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

toBuilder

public GetRecordsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static GetRecordsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo