Interface GetRecordsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>
,KinesisRequest.Builder
,SdkBuilder<GetRecordsRequest.Builder,GetRecordsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- GetRecordsRequest
public static interface GetRecordsRequest.Builder extends KinesisRequest.Builder, SdkPojo, CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetRecordsRequest.Builder
limit(Integer limit)
The maximum number of records to return.GetRecordsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetRecordsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetRecordsRequest.Builder
shardIterator(String shardIterator)
The position in the shard from which you want to start sequentially reading data records.GetRecordsRequest.Builder
streamARN(String streamARN)
The ARN of the stream.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.kinesis.model.KinesisRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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
. The default value is 10,000.- 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
. The default value is 10,000.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamARN
GetRecordsRequest.Builder streamARN(String streamARN)
The ARN of the stream.
- Parameters:
streamARN
- The ARN of the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetRecordsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
GetRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-