Class ScanOperation<T>
java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.internal.operations.ScanOperation<T>
- All Implemented Interfaces:
PaginatedIndexOperation<T,
,ScanRequest, ScanResponse> PaginatedOperation<T,
,ScanRequest, ScanResponse> PaginatedTableOperation<T,
ScanRequest, ScanResponse>
public class ScanOperation<T>
extends Object
implements PaginatedTableOperation<T,ScanRequest,ScanResponse>, PaginatedIndexOperation<T,ScanRequest,ScanResponse>
-
Method Summary
Modifier and TypeMethodDescriptionasyncServiceCall
(DynamoDbAsyncClient dynamoDbAsyncClient) Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.static <T> ScanOperation
<T> create
(ScanEnhancedRequest request) generateRequest
(TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension) This method generates the request that needs to be sent to a low levelDynamoDbClient
.The type, or name, of the operation.serviceCall
(DynamoDbClient dynamoDbClient) Provides a function for making the low level synchronous SDK call to DynamoDb.transformResponse
(ScanResponse response, TableSchema<T> tableSchema, OperationContext context, DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension) 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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.PaginatedIndexOperation
executeOnSecondaryIndex, executeOnSecondaryIndexAsync
Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.PaginatedOperation
execute, executeAsync
Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.PaginatedTableOperation
executeOnPrimaryIndex, executeOnPrimaryIndexAsync
-
Method Details
-
create
-
operationName
Description copied from interface:PaginatedTableOperation
The type, or name, of the operation.- Specified by:
operationName
in interfacePaginatedTableOperation<T,
ScanRequest, ScanResponse>
-
generateRequest
public ScanRequest generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension) Description copied from interface:PaginatedOperation
This method generates the request that needs to be sent to a low levelDynamoDbClient
.- Specified by:
generateRequest
in interfacePaginatedOperation<T,
ScanRequest, ScanResponse> - Parameters:
tableSchema
- ATableSchema
that maps the table to a modelled object.operationContext
- An object containing the context, or target, of the command execution.extension
- ADynamoDbEnhancedClientExtension
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, DynamoDbEnhancedClientExtension dynamoDbEnhancedClientExtension) 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 interfacePaginatedOperation<T,
ScanRequest, ScanResponse> - Parameters:
response
- The response object returned by the DynamoDb call for this operation.tableSchema
- ATableSchema
that maps the table to a modelled object.context
- An object containing the context, or target, of the command execution.dynamoDbEnhancedClientExtension
- ADynamoDbEnhancedClientExtension
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
Description copied from interface:PaginatedOperation
Provides a function for making the low level synchronous SDK call to DynamoDb.- Specified by:
serviceCall
in interfacePaginatedOperation<T,
ScanRequest, ScanResponse> - Parameters:
dynamoDbClient
- A low levelDynamoDbClient
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 interfacePaginatedOperation<T,
ScanRequest, ScanResponse> - Parameters:
dynamoDbAsyncClient
- A low levelDynamoDbAsyncClient
to make the call against.- Returns:
- A function that calls a paginated DynamoDb operation with a provided request object and returns the response object.
-