software.amazon.awssdk.services.kinesis.model

Interface GetRecordsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>, KinesisRequest.Builder, SdkBuilder<GetRecordsRequest.Builder,GetRecordsRequest>, SdkRequest.Builder

Enclosing class:

GetRecordsRequest

public static interface GetRecordsRequest.Builder
extends KinesisRequest.Builder, CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

Method Summary

Modifier and Type	Method and Description
GetRecordsRequest.Builder	limit(Integer limit) The maximum number of records to return.
GetRecordsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
GetRecordsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
GetRecordsRequest.Builder	shardIterator(String shardIterator) The position in the shard from which you want to start sequentially reading data records.

Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

shardIterator

GetRecordsRequest.Builder shardIterator(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.

limit

GetRecordsRequest.Builder limit(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 throws InvalidArgumentException.

Returns:

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

requestOverrideConfig

GetRecordsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

GetRecordsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.