software.amazon.awssdk.enhanced.dynamodb.internal.operations.PaginatedIndexOperation Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

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

import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.async.SdkPublisher;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClientExtension;
import software.amazon.awssdk.enhanced.dynamodb.OperationContext;
import software.amazon.awssdk.enhanced.dynamodb.TableSchema;
import software.amazon.awssdk.enhanced.dynamodb.model.Page;
import software.amazon.awssdk.enhanced.dynamodb.model.PageIterable;
import software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

/**
 * Interface for an operation that can be executed against a secondary index of a mapped database table and is
 * expected to return a paginated list of results. Typically, each page of results that is served will automatically
 * perform an additional service call to DynamoDb to retrieve the next set of results.
 * 
 * A concrete implementation of this interface should also implement {@link PaginatedTableOperation} with the same
 * types if the operation supports being executed against both the primary index and secondary indices.
 *
 * @param  The modelled object that this table maps records to.
 * @param   The type of the request object for the DynamoDb call in the low level {@link DynamoDbClient}.
 * @param  The type of the response object for the DynamoDb call in the low level {@link DynamoDbClient}.
 */
@SdkInternalApi
public interface PaginatedIndexOperation
    extends PaginatedOperation {
    /**
     * Default implementation of a complete synchronous execution of this operation against a secondary index. It will
     * construct a context based on the given table name and secondary index name and then call execute() on the
     * {@link PaginatedOperation} interface to perform the operation.
     *
     * @param tableSchema A {@link TableSchema} that maps the table to a modelled object.
     * @param tableName The physical name of the table that contains the secondary index to execute the operation
     *                  against.
     * @param indexName The physical name of the secondary index to execute the operation against.
     * @param dynamoDbClient A {@link DynamoDbClient} to make the call against.
     * @param extension A {@link DynamoDbEnhancedClientExtension} that may modify the request or result of this
     *                  operation. A null value here will result in no modifications.
     * @return A high level result object as specified by the implementation of this operation.
     */
    default PageIterable executeOnSecondaryIndex(TableSchema tableSchema,
                                                        String tableName,
                                                        String indexName,
                                                        DynamoDbEnhancedClientExtension extension,
                                                        DynamoDbClient dynamoDbClient) {
        OperationContext context = DefaultOperationContext.create(tableName, indexName);
        return execute(tableSchema, context, extension, dynamoDbClient);
    }

    /**
     * Default implementation of a complete non-blocking asynchronous execution of this operation against a secondary
     * index. It will construct a context based on the given table name and secondary index name and then call
     * executeAsync() on the {@link PaginatedOperation} interface to perform the operation.
     *
     * @param tableSchema A {@link TableSchema} that maps the table to a modelled object.
     * @param tableName The physical name of the table that contains the secondary index to execute the operation
     *                  against.
     * @param indexName The physical name of the secondary index to execute the operation against.
     * @param dynamoDbAsyncClient A {@link DynamoDbAsyncClient} to make the call against.
     * @param extension A {@link DynamoDbEnhancedClientExtension} that may modify the request or result of this
     *                  operation. A null value here will result in no modifications.
     * @return A high level result object as specified by the implementation of this operation.
     */
    default SdkPublisher> executeOnSecondaryIndexAsync(TableSchema tableSchema,
                                                                   String tableName,
                                                                   String indexName,
                                                                   DynamoDbEnhancedClientExtension extension,
                                                                   DynamoDbAsyncClient dynamoDbAsyncClient) {
        OperationContext context = DefaultOperationContext.create(tableName, indexName);
        return executeAsync(tableSchema, context, extension, dynamoDbAsyncClient);
    }
}