software.amazon.awssdk.enhanced.dynamodb.internal.operations

Class DescribeTableOperation<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.operations.DescribeTableOperation<T>

All Implemented Interfaces:

CommonOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>, TableOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

public class DescribeTableOperation<T>
extends Object
implements TableOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

Constructor Summary

Constructors

Constructor and Description
DescribeTableOperation()

Method Summary

Modifier and Type	Method and Description
Function<DescribeTableRequest,CompletableFuture<DescribeTableResponse>>	asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient) Provides a function for making the low level non-blocking asynchronous SDK call to DynamoDb.
static <T> DescribeTableOperation<T>	create()
DescribeTableRequest	generateRequest(TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension) This method generates the request that needs to be sent to a low level DynamoDbClient.
OperationName	operationName() The type, or name, of the operation.
Function<DescribeTableRequest,DescribeTableResponse>	serviceCall(DynamoDbClient dynamoDbClient) Provides a function for making the low level synchronous SDK call to DynamoDb.
DescribeTableEnhancedResponse	transformResponse(DescribeTableResponse response, TableSchema<T> tableSchema, OperationContext operationContext, DynamoDbEnhancedClientExtension extension) 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.TableOperation

executeOnPrimaryIndex, executeOnPrimaryIndexAsync

Methods inherited from interface software.amazon.awssdk.enhanced.dynamodb.internal.operations.CommonOperation

execute, executeAsync

Constructor Detail

DescribeTableOperation

public DescribeTableOperation()

Method Detail

create

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

operationName

public OperationName operationName()

Description copied from interface: CommonOperation

The type, or name, of the operation.

Specified by:

operationName in interface CommonOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

generateRequest

public DescribeTableRequest generateRequest(TableSchema<T> tableSchema,
                                            OperationContext operationContext,
                                            DynamoDbEnhancedClientExtension extension)

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,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

Parameters:

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

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

extension - A DynamoDbEnhancedClientExtension 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.

serviceCall

public Function<DescribeTableRequest,DescribeTableResponse> serviceCall(DynamoDbClient dynamoDbClient)

Description copied from interface: CommonOperation

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

Specified by:

serviceCall in interface CommonOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

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.

asyncServiceCall

public Function<DescribeTableRequest,CompletableFuture<DescribeTableResponse>> asyncServiceCall(DynamoDbAsyncClient dynamoDbAsyncClient)

Description copied from interface: CommonOperation

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

Specified by:

asyncServiceCall in interface CommonOperation<T,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

Parameters:

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

Returns:

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

transformResponse

public DescribeTableEnhancedResponse transformResponse(DescribeTableResponse response,
                                                       TableSchema<T> tableSchema,
                                                       OperationContext operationContext,
                                                       DynamoDbEnhancedClientExtension extension)

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,DescribeTableRequest,DescribeTableResponse,DescribeTableEnhancedResponse>

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.

extension - A DynamoDbEnhancedClientExtension 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.