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 Details

    • 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 throws InvalidArgumentException. 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.