Chad Wilson
💻
+ * The additional configuration parameters that the enhanced client supports are defined + * in the {@link GetItemEnhancedRequest}. + *
+ * This operation calls the low-level DynamoDB API GetItem operation. Consult the GetItem documentation for + * further details and constraints. + *
+ * Example: + *
+ * {@code
+ *
+ * MyItem item = mappedTable.getItemWithResponse(GetItemEnhancedRequest.builder().key(key).build()).join();
+ * }
+ *
+ *
+ * @param request A {@link GetItemEnhancedRequest} with key and optional directives for retrieving an item from the table.
+ * @return a {@link CompletableFuture} of the item that was persisted in the database before it was deleted.
+ */
+ default CompletableFuture+ * The additional configuration parameters that the enhanced client supports are defined + * in the {@link GetItemEnhancedRequest}. + *
+ * This operation calls the low-level DynamoDB API GetItem operation. Consult the GetItem documentation for + * further details and constraints. + *
+ * Note: This is a convenience method that creates an instance of the request builder avoiding the need to create one + * manually via {@link GetItemEnhancedRequest#builder()}. + *
+ * Example: + *
+ * {@code
+ *
+ * MyItem item = mappedTable.getItemWithResponse(r -> r.key(key)).join();
+ * }
+ *
+ *
+ * @param requestConsumer A {@link Consumer} of {@link GetItemEnhancedRequest.Builder} with key and optional directives
+ * for retrieving an item from the table.
+ * @return a {@link CompletableFuture} of the retrieved item
+ */
+ default CompletableFuture
* The additional configuration parameters that the enhanced client supports are defined
@@ -336,7 +336,7 @@ default CompletableFuture
+ * The additional configuration parameters that the enhanced client supports are defined
+ * in the {@link GetItemEnhancedRequest}.
+ *
+ * This operation calls the low-level DynamoDB API GetItem operation. Consult the GetItem documentation for
+ * further details and constraints.
+ *
+ * Example:
+ *
+ * The additional configuration parameters that the enhanced client supports are defined
+ * in the {@link GetItemEnhancedRequest}.
+ *
+ * This operation calls the low-level DynamoDB API GetItem operation. Consult the GetItem documentation for
+ * further details and constraints.
+ *
+ * Note: This is a convenience method that creates an instance of the request builder avoiding the need to
+ * create one manually via {@link GetItemEnhancedRequest#builder()}.
+ *
+ * Example:
+ * You must also specify at least one index name.
+ *
+ * The index name will be used if a table is created from this bean. For data-oriented operations like reads and writes, this
+ * name does not need to match the service-side name of the index.
*/
@SdkPublicApi
@Target({ElementType.METHOD})
diff --git a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/annotations/DynamoDbSecondarySortKey.java b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/annotations/DynamoDbSecondarySortKey.java
index a39b982b4980..9fdee8065196 100644
--- a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/annotations/DynamoDbSecondarySortKey.java
+++ b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/mapper/annotations/DynamoDbSecondarySortKey.java
@@ -23,10 +23,14 @@
import software.amazon.awssdk.enhanced.dynamodb.internal.mapper.BeanTableSchemaAttributeTags;
/**
- * Denotes an optional sort key for a global or local secondary index. You must also specify the index name which in the
- * case of a global secondary index must match the index name supplied with the secondary partition key for the same
- * index. This name is only referenced internally by the enhanced client to disambiguate the index and does not actually
- * need to match the real name of the index.
+ * Denotes an optional sort key for a global or local secondary index.
+ *
+ * You must also specify at least one index name. For global secondary indices, this must match an index name specified in
+ * a {@link DynamoDbSecondaryPartitionKey}. Any index names specified that do not have an associated
+ * {@link DynamoDbSecondaryPartitionKey} are treated as local secondary indexes.
+ *
+ * The index name will be used if a table is created from this bean. For data-oriented operations like reads and writes, this
+ * name does not need to match the service-side name of the index.
*/
@SdkPublicApi
@Target({ElementType.METHOD})
@@ -35,6 +39,10 @@
public @interface DynamoDbSecondarySortKey {
/**
* The names of one or more local or global secondary indices that this sort key should participate in.
+ *
+ * For global secondary indices, this must match an index name specified in a {@link DynamoDbSecondaryPartitionKey}. Any
+ * index names specified that do not have an associated {@link DynamoDbSecondaryPartitionKey} are treated as local
+ * secondary indexes.
*/
String[] indexNames();
}
diff --git a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchGetItemEnhancedRequest.java b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchGetItemEnhancedRequest.java
index 9c360aa9f225..ea2bdc8fd1fc 100644
--- a/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchGetItemEnhancedRequest.java
+++ b/services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/BatchGetItemEnhancedRequest.java
@@ -20,10 +20,14 @@
import java.util.Collection;
import java.util.Collections;
import java.util.List;
+import java.util.Objects;
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.services.dynamodb.model.BatchGetItemRequest;
+import software.amazon.awssdk.services.dynamodb.model.GetItemRequest;
+import software.amazon.awssdk.services.dynamodb.model.ReturnConsumedCapacity;
/**
* Defines parameters used for the batchGetItem() operation (such as
@@ -36,9 +40,11 @@
public final class BatchGetItemEnhancedRequest {
private final List
+ * Similar to {@link #returnConsumedCapacity()} but return the value as a string. This is useful in situations where the
+ * value is not defined in {@link ReturnConsumedCapacity}.
+ */
+ public String returnConsumedCapacityAsString() {
+ return returnConsumedCapacity;
+ }
+
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -73,12 +98,15 @@ public boolean equals(Object o) {
BatchGetItemEnhancedRequest that = (BatchGetItemEnhancedRequest) o;
- return readBatches != null ? readBatches.equals(that.readBatches) : that.readBatches == null;
+ return Objects.equals(this.readBatches, that.readBatches) &&
+ Objects.equals(this.returnConsumedCapacity, that.returnConsumedCapacity);
}
@Override
public int hashCode() {
- return readBatches != null ? readBatches.hashCode() : 0;
+ int hc = readBatches != null ? readBatches.hashCode() : 0;
+ hc = 31 * hc + (returnConsumedCapacity != null ? returnConsumedCapacity.hashCode() : 0);
+ return hc;
}
private static List
+ * Similar to {@link #returnConsumedCapacity()} but return the value as a string. This is useful in situations where the
+ * value is not defined in {@link ReturnConsumedCapacity}.
+ */
+ public String returnConsumedCapacityAsString() {
+ return returnConsumedCapacity;
+ }
+
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -79,18 +103,18 @@ public boolean equals(Object o) {
return false;
}
- GetItemEnhancedRequest getItem = (GetItemEnhancedRequest) o;
+ GetItemEnhancedRequest that = (GetItemEnhancedRequest) o;
- if (key != null ? ! key.equals(getItem.key) : getItem.key != null) {
- return false;
- }
- return consistentRead != null ? consistentRead.equals(getItem.consistentRead) : getItem.consistentRead == null;
+ return Objects.equals(key, that.key)
+ && Objects.equals(consistentRead, that.consistentRead)
+ && Objects.equals(returnConsumedCapacity, that.returnConsumedCapacity);
}
@Override
public int hashCode() {
int result = key != null ? key.hashCode() : 0;
result = 31 * result + (consistentRead != null ? consistentRead.hashCode() : 0);
+ result = 31 * result + (returnConsumedCapacity != null ? returnConsumedCapacity.hashCode() : 0);
return result;
}
@@ -103,6 +127,7 @@ public int hashCode() {
public static final class Builder {
private Key key;
private Boolean consistentRead;
+ private String returnConsumedCapacity;
private Builder() {
}
@@ -145,6 +170,26 @@ public Builder key(Consumer
+ * Similar to {@link #returnConsumedCapacity()} but return the value as a string. This is useful in situations where the
+ * value is not defined in {@link ReturnConsumedCapacity}.
+ */
+ public String returnConsumedCapacityAsString() {
+ return returnConsumedCapacity;
+ }
+
@Override
public boolean equals(Object o) {
if (this == o) {
@@ -182,6 +208,10 @@ public boolean equals(Object o) {
? !attributesToProject.equals(query.attributesToProject) : query.attributesToProject != null) {
return false;
}
+ if (returnConsumedCapacity != null
+ ? !returnConsumedCapacity.equals(query.returnConsumedCapacity) : query.returnConsumedCapacity != null) {
+ return false;
+ }
return filterExpression != null ? filterExpression.equals(query.filterExpression) : query.filterExpression == null;
}
@@ -194,6 +224,7 @@ public int hashCode() {
result = 31 * result + (consistentRead != null ? consistentRead.hashCode() : 0);
result = 31 * result + (filterExpression != null ? filterExpression.hashCode() : 0);
result = 31 * result + (attributesToProject != null ? attributesToProject.hashCode() : 0);
+ result = 31 * result + (returnConsumedCapacity != null ? returnConsumedCapacity.hashCode() : 0);
return result;
}
@@ -211,6 +242,7 @@ public static final class Builder {
private Boolean consistentRead;
private Expression filterExpression;
private List
+ * Similar to {@link #returnConsumedCapacity()} but return the value as a string. This is useful in situations where the
+ * value is not defined in {@link ReturnConsumedCapacity}.
+ */
+ public String returnConsumedCapacityAsString() {
+ return returnConsumedCapacity;
+ }
@Override
public boolean equals(Object o) {
@@ -175,6 +200,10 @@ public boolean equals(Object o) {
? !attributesToProject.equals(scan.attributesToProject) : scan.attributesToProject != null) {
return false;
}
+ if (returnConsumedCapacity != null
+ ? !returnConsumedCapacity.equals(scan.returnConsumedCapacity) : scan.returnConsumedCapacity != null) {
+ return false;
+ }
return filterExpression != null ? filterExpression.equals(scan.filterExpression) : scan.filterExpression == null;
}
@@ -187,6 +216,7 @@ public int hashCode() {
result = 31 * result + (consistentRead != null ? consistentRead.hashCode() : 0);
result = 31 * result + (filterExpression != null ? filterExpression.hashCode() : 0);
result = 31 * result + (attributesToProject != null ? attributesToProject.hashCode() : 0);
+ result = 31 * result + (returnConsumedCapacity != null ? returnConsumedCapacity.hashCode() : 0);
return result;
}
@@ -202,6 +232,7 @@ public static final class Builder {
private List
*
*
+ * {@code
+ *
+ * MyItem item = mappedTable.getItemWithResponse(GetItemEnhancedRequest.builder().key(key).build());
+ * }
+ *
+ *
+ * @param request A {@link GetItemEnhancedRequest} with key and optional directives for retrieving an item from the
+ * table.
+ * @return The retrieved item
+ */
+ default GetItemEnhancedResponse
+ * {@code
+ *
+ * MyItem item = mappedTable.getItemWithResponse(r -> r.key(key));
+ * }
+ *
+ *
+ * @param requestConsumer A {@link Consumer} of {@link GetItemEnhancedRequest.Builder} with key and optional
+ * directives for retrieving an item from the table.
+ * @return The retrieved item
+ */
+ default GetItemEnhancedResponse