Interface GetRecordsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>, KeyspacesStreamsRequest.Builder, SdkBuilder<GetRecordsRequest.Builder,GetRecordsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetRecordsRequest
@Mutable @NotThreadSafe public static interface GetRecordsRequest.Builder extends KeyspacesStreamsRequest.Builder, SdkPojo, CopyableBuilder<GetRecordsRequest.Builder,GetRecordsRequest>

  • Method Details

    • shardIterator

      GetRecordsRequest.Builder shardIterator(String shardIterator)

      The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 5 minutes after creation.

      Parameters:
      shardIterator - The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the GetShardIterator operation. Each shard iterator is valid for 5 minutes after creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetRecordsRequest.Builder maxResults(Integer maxResults)

      The maximum number of records to return in a single GetRecords request. Default value is 1000. You can specify a limit between 1 and 10000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.

      Parameters:
      maxResults - The maximum number of records to return in a single GetRecords request. Default value is 1000. You can specify a limit between 1 and 10000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit.
      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.