software.amazon.awssdk.enhanced.dynamodb.model.TransactGetItemsEnhancedRequest 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.model;

import static software.amazon.awssdk.enhanced.dynamodb.internal.EnhancedClientUtils.getItemsFromSupplier;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Supplier;
import software.amazon.awssdk.annotations.NotThreadSafe;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient;
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.MappedTableResource;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.DefaultOperationContext;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.GetItemOperation;
import software.amazon.awssdk.enhanced.dynamodb.internal.operations.TransactableReadOperation;
import software.amazon.awssdk.services.dynamodb.model.TransactGetItem;

/**
 * Defines parameters used for the transaction operation transactGetItems() (such as
 * {@link DynamoDbEnhancedClient#transactGetItems(TransactGetItemsEnhancedRequest)}).
 * 
 * A request contains references to the primary keys for the items this operation will search for.
 * It's populated with one or more {@link GetItemEnhancedRequest}, each associated with with the table where the item is located.
 * On initialization, these requests are transformed into {@link TransactGetItem} and stored in the request.
 * .
 */
@SdkPublicApi
@ThreadSafe
public final class TransactGetItemsEnhancedRequest {

    private final List transactGetItems;

    private TransactGetItemsEnhancedRequest(Builder builder) {
        this.transactGetItems = getItemsFromSupplier(builder.itemSupplierList);
    }

    /**
     * Creates a newly initialized builder for a request object.
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Returns the list of {@link TransactGetItem} that represents all lookup keys in the request.
     */
    public List transactGetItems() {
        return transactGetItems;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        TransactGetItemsEnhancedRequest that = (TransactGetItemsEnhancedRequest) o;

        return transactGetItems != null ? transactGetItems.equals(that.transactGetItems) : that.transactGetItems == null;
    }

    @Override
    public int hashCode() {
        return transactGetItems != null ? transactGetItems.hashCode() : 0;
    }

    /**
     * A builder that is used to create a transaction object with the desired parameters.
     * 
     * A valid builder should contain at least one {@link GetItemEnhancedRequest} added through addGetItem().
     */
    @NotThreadSafe
    public static final class Builder {
        private List> itemSupplierList = new ArrayList<>();

        private Builder() {
        }

        /**
         * Adds a primary lookup key and it's associated table to the transaction.
         *
         * @param mappedTableResource the table where the key is located
         * @param request A {@link GetItemEnhancedRequest}
         * @return a builder of this type
         */
        public Builder addGetItem(MappedTableResource mappedTableResource, GetItemEnhancedRequest request) {
            itemSupplierList.add(() -> generateTransactWriteItem(mappedTableResource, GetItemOperation.create(request)));
            return this;
        }

        /**
         * Adds a primary lookup key and it's associated table to the transaction.
         *
         * @param mappedTableResource the table where the key is located
         * @param key the primary key of an item to retrieve as part of the transaction
         * @return a builder of this type
         */
        public Builder addGetItem(MappedTableResource mappedTableResource, Key key) {
            return addGetItem(mappedTableResource, GetItemEnhancedRequest.builder().key(key).build());
        }

        /**
         * Adds a primary lookup key and it's associated table to the transaction.
         *
         * @param mappedTableResource the table where the key is located
         * @param keyItem an item that will have its key fields used to match a record to retrieve from the database
         * @param  the type of modelled objects in the table
         * @return a builder of this type
         */
        public  Builder addGetItem(MappedTableResource mappedTableResource,
                                      T keyItem) {
            return addGetItem(mappedTableResource, mappedTableResource.keyFrom(keyItem));
        }

        /**
         * Builds a {@link TransactGetItemsEnhancedRequest} from the values stored in this builder.
         */
        public TransactGetItemsEnhancedRequest build() {
            return new TransactGetItemsEnhancedRequest(this);
        }

        private  TransactGetItem generateTransactWriteItem(MappedTableResource mappedTableResource,
                                                              TransactableReadOperation generator) {
            return generator.generateTransactGetItem(mappedTableResource.tableSchema(),
                                                     DefaultOperationContext.create(mappedTableResource.tableName()),
                                                     mappedTableResource.mapperExtension());
        }
    }
}