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:

CommonOperation<T,ScanRequest,ScanIterable,Iterable<Page<T>>>, IndexOperation<T,ScanRequest,ScanIterable,Iterable<Page<T>>>, TableOperation<T,ScanRequest,ScanIterable,Iterable<Page<T>>>

public class Scan<T>
extends Object
implements TableOperation<T,ScanRequest,ScanIterable,Iterable<Page<T>>>, IndexOperation<T,ScanRequest,ScanIterable,Iterable<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
static Scan.Builder	builder()
static <T> Scan<T>	create()
boolean	equals(Object o)
ScanRequest	generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, MapperExtension mapperExtension) This method generates the request that needs to be sent to a low level DynamoDbClient.
Boolean	getConsistentRead()
Map<String,AttributeValue>	getExclusiveStartKey()
Expression	getFilterExpression()
Integer	getLimit()
Function<ScanRequest,ScanIterable>	getServiceCall(DynamoDbClient dynamoDbClient) Provides a function for making the low level SDK call to DynamoDb.
int	hashCode()
Scan.Builder	toBuilder()
Iterable<Page<T>>	transformResponse(ScanIterable response, TableSchema<T> tableSchema, OperationContext operationContext, 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.TableOperation

executeOnPrimaryIndex

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

executeOnSecondaryIndex

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

execute

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: CommonOperation

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

Specified by:

generateRequest in interface CommonOperation<T,ScanRequest,ScanIterable,Iterable<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 Iterable<Page<T>> transformResponse(ScanIterable response,
                                           TableSchema<T> tableSchema,
                                           OperationContext operationContext,
                                           MapperExtension mapperExtension)

Description copied from interface: CommonOperation

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 CommonOperation<T,ScanRequest,ScanIterable,Iterable<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.

operationContext - 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.

getServiceCall

public Function<ScanRequest,ScanIterable> getServiceCall(DynamoDbClient dynamoDbClient)

Description copied from interface: CommonOperation

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

Specified by:

getServiceCall in interface CommonOperation<T,ScanRequest,ScanIterable,Iterable<Page<T>>>

Parameters:

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

Returns:

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

getExclusiveStartKey

public Map<String,AttributeValue> getExclusiveStartKey()

getLimit

public Integer getLimit()

getConsistentRead

public Boolean getConsistentRead()

getFilterExpression

public Expression getFilterExpression()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object