software.amazon.awssdk.enhanced.dynamodb.model

Class ScanEnhancedRequest.Builder

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest.Builder

Enclosing class:

ScanEnhancedRequest

public static final class ScanEnhancedRequest.Builder
extends Object

A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method and Description
ScanEnhancedRequest	build()
ScanEnhancedRequest.Builder	consistentRead(Boolean consistentRead) Determines the read consistency model: If set to true, the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
ScanEnhancedRequest.Builder	exclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey) The primary key of the first item that this operation will evaluate.
ScanEnhancedRequest.Builder	filterExpression(Expression filterExpression) Refines the scan results by applying the filter expression on the results returned from the scan and discards items that do not match.
ScanEnhancedRequest.Builder	limit(Integer limit) Sets a limit on how many items to evaluate in the scan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

exclusiveStartKey

public ScanEnhancedRequest.Builder exclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)

The primary key of the first item that this operation will evaluate. By default, the operation will evaluate the whole dataset. If used, normally this parameter is populated with the value that was returned for Page.lastEvaluatedKey() in the previous operation.

Parameters:

exclusiveStartKey - the primary key value where DynamoDb should start to evaluate items

Returns:

a builder of this type

limit

public ScanEnhancedRequest.Builder limit(Integer limit)

Sets a limit on how many items to evaluate in the scan. If not set, the operation uses the maximum values allowed.

Note:The limit does not refer to the number of items to return, but how many items the database should evaluate while executing the scan. Use limit together with Page.lastEvaluatedKey() and exclusiveStartKey in subsequent scan calls to evaluate limit items per call.

Parameters:

limit - the maximum number of items to evalute

Returns:

a builder of this type

consistentRead

public ScanEnhancedRequest.Builder consistentRead(Boolean consistentRead)

Determines the read consistency model: If set to true, the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

By default, the value of this property is set to false.

Parameters:

consistentRead - sets consistency model of the operation to use strong consistency if true

Returns:

a builder of this type

filterExpression

public ScanEnhancedRequest.Builder filterExpression(Expression filterExpression)

Refines the scan results by applying the filter expression on the results returned from the scan and discards items that do not match. See Expression for examples and constraints.

Note: Using the filter expression does not reduce the cost of the scan, since it is applied after the database has found matching items.

Parameters:

filterExpression - an expression that filters results of evaluating the scan

Returns:

a builder of this type

build

public ScanEnhancedRequest build()