software.amazon.awssdk.extensions.dynamodb.mappingclient.operations

Class Scan<T>

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.operations.Scan<T>

All Implemented Interfaces:

PaginatedIndexOperation<T,ScanRequest,ScanResponse,Page<T>>, PaginatedOperation<T,ScanRequest,ScanResponse,Page<T>>, PaginatedTableOperation<T,ScanRequest,ScanResponse,Page<T>>

public class Scan<T>
extends Object
implements PaginatedTableOperation<T,ScanRequest,ScanResponse,Page<T>>, PaginatedIndexOperation<T,ScanRequest,ScanResponse,Page<T>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scan.Builder

Method Summary

Modifier and Type	Method and Description
Function<ScanRequest,SdkPublisher<ScanResponse>>	asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient) Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.
static Scan.Builder	builder()
Boolean	consistentRead()
static <T> Scan<T>	create()
boolean	equals(Object o)
Map<String,AttributeValue>	exclusiveStartKey()
Expression	filterExpression()
ScanRequest	generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension) This method generates the request that needs to be sent to a low level DynamoDbClient.
int	hashCode()
Integer	limit()
Function<ScanRequest,SdkIterable<ScanResponse>>	serviceCall(DynamoDbClient dynamoDbClient) Provides a function for making the low level synchronous SDK call to DynamoDb.
Scan.Builder	toBuilder()
Page<T>	transformResponse(ScanResponse response, TableSchema<T> tableSchema, OperationContext context, MapperExtension mapperExtension) Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted result object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.PaginatedTableOperation

executeOnPrimaryIndex, executeOnPrimaryIndexAsync

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.PaginatedIndexOperation

executeOnSecondaryIndex, executeOnSecondaryIndexAsync

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.PaginatedOperation

execute, executeAsync

Method Detail

create

public static <T> Scan<T> create()

builder

public static Scan.Builder builder()

toBuilder

public Scan.Builder toBuilder()

generateRequest

public ScanRequest generateRequest(TableSchema<T> tableSchema,
                                   OperationContext operationContext,
                                   MapperExtension mapperExtension)

Description copied from interface: PaginatedOperation

This method generates the request that needs to be sent to a low level DynamoDbClient.

Specified by:

generateRequest in interface PaginatedOperation<T,ScanRequest,ScanResponse,Page<T>>

Parameters:

tableSchema - A TableSchema that maps the table to a modelled object.

operationContext - An object containing the context, or target, of the command execution.

mapperExtension - A MapperExtension that may modify the request of this operation. A null value here will result in no modifications.

Returns:

A request that can be used as an argument to a DynamoDbClient call to perform the operation.

transformResponse

public Page<T> transformResponse(ScanResponse response,
                                 TableSchema<T> tableSchema,
                                 OperationContext context,
                                 MapperExtension mapperExtension)

Description copied from interface: PaginatedOperation

Takes the response object returned by the actual DynamoDb call and maps it into a higher level abstracted result object.

Specified by:

transformResponse in interface PaginatedOperation<T,ScanRequest,ScanResponse,Page<T>>

Parameters:

response - The response object returned by the DynamoDb call for this operation.

tableSchema - A TableSchema that maps the table to a modelled object.

context - An object containing the context, or target, of the command execution.

mapperExtension - A MapperExtension that may modify the result of this operation. A null value here will result in no modifications.

Returns:

A high level result object as specified by the implementation of this operation.

serviceCall

public Function<ScanRequest,SdkIterable<ScanResponse>> serviceCall(DynamoDbClient dynamoDbClient)

Description copied from interface: PaginatedOperation

Provides a function for making the low level synchronous SDK call to DynamoDb.

Specified by:

serviceCall in interface PaginatedOperation<T,ScanRequest,ScanResponse,Page<T>>

Parameters:

dynamoDbClient - A low level DynamoDbClient to make the call against.

Returns:

A function that calls a paginated DynamoDb operation with a provided request object and returns the response object.

asyncServiceCall

public Function<ScanRequest,SdkPublisher<ScanResponse>> asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient)

Description copied from interface: PaginatedOperation

Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.

Specified by:

asyncServiceCall in interface PaginatedOperation<T,ScanRequest,ScanResponse,Page<T>>

Parameters:

dynamoDbAsyncClient - A low level DynamoDbAsyncClient to make the call against.

Returns:

A function that calls a paginated DynamoDb operation with a provided request object and returns the response object.

exclusiveStartKey

public Map<String,AttributeValue> exclusiveStartKey()

limit

public Integer limit()

consistentRead

public Boolean consistentRead()

filterExpression

public Expression filterExpression()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object