Issue #3365 - adding response metadata into enhanced response objects

.changes/next-release/feature-AmazonDynamoDB-24a4d1f.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon DynamoDB",
+    "contributor": "petercipov",
+    "description": "Pass DynamoDbResponseMetadata via ItemEnhancedResponse objects to retrieve requestId using enhanced client"
+}

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/operations/DeleteItemOperation.java

@@ -108,6 +108,7 @@ public DeleteItemEnhancedResponse<T> transformResponse(DeleteItemResponse respon
                                          .attributes(attributes)
                                          .consumedCapacity(response.consumedCapacity())
                                          .itemCollectionMetrics(response.itemCollectionMetrics())
+                                         .responseMetadata(response.responseMetadata())
                                          .build();
     }
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/operations/PutItemOperation.java

@@ -132,6 +132,7 @@ public PutItemEnhancedResponse<T> transformResponse(PutItemResponse response,
                                       .attributes(attributes)
                                       .consumedCapacity(response.consumedCapacity())
                                       .itemCollectionMetrics(response.itemCollectionMetrics())
+                                      .responseMetadata(response.responseMetadata())
                                       .build();
     }
 

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/operations/UpdateItemOperation.java

@@ -155,6 +155,7 @@ public UpdateItemEnhancedResponse<T> transformResponse(UpdateItemResponse respon
                 .attributes(attributes)
                 .consumedCapacity(response.consumedCapacity())
                 .itemCollectionMetrics(response.itemCollectionMetrics())
+                .responseMetadata(response.responseMetadata())
                 .build();
         } catch (RuntimeException e) {
             // With a partial update it's possible to update the record into a state that the mapper can no longer

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/DeleteItemEnhancedResponse.java

@@ -23,6 +23,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable;
 import software.amazon.awssdk.services.dynamodb.model.ConsumedCapacity;
 import software.amazon.awssdk.services.dynamodb.model.DeleteItemResponse;
+import software.amazon.awssdk.services.dynamodb.model.DynamoDbResponseMetadata;
 import software.amazon.awssdk.services.dynamodb.model.ItemCollectionMetrics;
 
 /**
@@ -38,11 +39,13 @@ public final class DeleteItemEnhancedResponse<T> {
     private final T attributes;
     private final ConsumedCapacity consumedCapacity;
     private final ItemCollectionMetrics itemCollectionMetrics;
+    private final DynamoDbResponseMetadata responseMetadata;
 
     private DeleteItemEnhancedResponse(Builder<T> builder) {
         this.attributes = builder.attributes;
         this.consumedCapacity = builder.consumedCapacity;
         this.itemCollectionMetrics = builder.itemCollectionMetrics;
+        this.responseMetadata = builder.responseMetadata;
     }
 
     /**
@@ -70,6 +73,14 @@ public ItemCollectionMetrics itemCollectionMetrics() {
         return itemCollectionMetrics;
     }
 
+    /**
+     * The response metadata, f.e. requestId
+     * @see DeleteItemResponse#responseMetadata() ()
+     */
+    public DynamoDbResponseMetadata responseMetadata() {
+        return responseMetadata;
+    }
+
     public static <T> Builder<T> builder(Class<? extends T> clzz) {
         return new Builder<>();
     }
@@ -86,14 +97,16 @@ public boolean equals(Object o) {
         DeleteItemEnhancedResponse<?> that = (DeleteItemEnhancedResponse<?>) o;
         return Objects.equals(attributes, that.attributes)
                && Objects.equals(consumedCapacity, that.consumedCapacity)
-               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics);
+               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics)
+               && Objects.equals(responseMetadata, that.responseMetadata);
     }
 
     @Override
     public int hashCode() {
         int result = Objects.hashCode(attributes);
         result = 31 * result + Objects.hashCode(consumedCapacity);
         result = 31 * result + Objects.hashCode(itemCollectionMetrics);
+        result = 31 * result + Objects.hashCode(responseMetadata);
         return result;
     }
 
@@ -102,6 +115,8 @@ public static final class Builder<T> {
         private T attributes;
         private ConsumedCapacity consumedCapacity;
         private ItemCollectionMetrics itemCollectionMetrics;
+        private DynamoDbResponseMetadata responseMetadata;
+
 
         public Builder<T> attributes(T attributes) {
             this.attributes = attributes;
@@ -118,6 +133,11 @@ public Builder<T> itemCollectionMetrics(ItemCollectionMetrics itemCollectionMetr
             return this;
         }
 
+        public Builder<T> responseMetadata(DynamoDbResponseMetadata responseMetadata) {
+            this.responseMetadata = responseMetadata;
+            return this;
+        }
+
         public DeleteItemEnhancedResponse<T> build() {
             return new DeleteItemEnhancedResponse<>(this);
         }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/PutItemEnhancedResponse.java

@@ -22,6 +22,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.DynamoDbAsyncTable;
 import software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable;
 import software.amazon.awssdk.services.dynamodb.model.ConsumedCapacity;
+import software.amazon.awssdk.services.dynamodb.model.DynamoDbResponseMetadata;
 import software.amazon.awssdk.services.dynamodb.model.ItemCollectionMetrics;
 import software.amazon.awssdk.services.dynamodb.model.PutItemResponse;
 
@@ -37,11 +38,13 @@ public final class PutItemEnhancedResponse<T> {
     private final T attributes;
     private final ConsumedCapacity consumedCapacity;
     private final ItemCollectionMetrics itemCollectionMetrics;
+    private final DynamoDbResponseMetadata responseMetadata;
 
     private PutItemEnhancedResponse(Builder<T> builder) {
         this.attributes = builder.attributes;
         this.consumedCapacity = builder.consumedCapacity;
         this.itemCollectionMetrics = builder.itemCollectionMetrics;
+        this.responseMetadata = builder.responseMetadata;
     }
 
     /**
@@ -69,6 +72,14 @@ public ItemCollectionMetrics itemCollectionMetrics() {
         return itemCollectionMetrics;
     }
 
+    /**
+     * The response metadata, f.e. requestId
+     * @see PutItemResponse#responseMetadata() ()
+     */
+    public DynamoDbResponseMetadata responseMetadata() {
+        return responseMetadata;
+    }
+
     public static <T> Builder<T> builder(Class<? extends T> clzz) {
         return new Builder<>();
     }
@@ -85,14 +96,16 @@ public boolean equals(Object o) {
         PutItemEnhancedResponse<?> that = (PutItemEnhancedResponse<?>) o;
         return Objects.equals(attributes, that.attributes)
                && Objects.equals(consumedCapacity, that.consumedCapacity)
-               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics);
+               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics)
+               && Objects.equals(responseMetadata, that.responseMetadata);
     }
 
     @Override
     public int hashCode() {
         int result = Objects.hashCode(attributes);
         result = 31 * result + Objects.hashCode(consumedCapacity);
         result = 31 * result + Objects.hashCode(itemCollectionMetrics);
+        result = 31 * result + Objects.hashCode(responseMetadata);
         return result;
     }
 
@@ -101,6 +114,7 @@ public static final class Builder<T> {
         private T attributes;
         private ConsumedCapacity consumedCapacity;
         private ItemCollectionMetrics itemCollectionMetrics;
+        private DynamoDbResponseMetadata responseMetadata;
 
         public Builder<T> attributes(T attributes) {
             this.attributes = attributes;
@@ -117,6 +131,11 @@ public Builder<T> itemCollectionMetrics(ItemCollectionMetrics itemCollectionMetr
             return this;
         }
 
+        public Builder<T> responseMetadata(DynamoDbResponseMetadata responseMetadata) {
+            this.responseMetadata = responseMetadata;
+            return this;
+        }
+
         public PutItemEnhancedResponse<T> build() {
             return new PutItemEnhancedResponse<>(this);
         }

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/model/UpdateItemEnhancedResponse.java

@@ -22,6 +22,7 @@
 import software.amazon.awssdk.enhanced.dynamodb.DynamoDbAsyncTable;
 import software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable;
 import software.amazon.awssdk.services.dynamodb.model.ConsumedCapacity;
+import software.amazon.awssdk.services.dynamodb.model.DynamoDbResponseMetadata;
 import software.amazon.awssdk.services.dynamodb.model.ItemCollectionMetrics;
 import software.amazon.awssdk.services.dynamodb.model.UpdateItemResponse;
 
@@ -38,11 +39,13 @@ public final class UpdateItemEnhancedResponse<T> {
     private final T attributes;
     private final ConsumedCapacity consumedCapacity;
     private final ItemCollectionMetrics itemCollectionMetrics;
+    private final DynamoDbResponseMetadata responseMetadata;
 
     private UpdateItemEnhancedResponse(Builder<T> builder) {
         this.attributes = builder.attributes;
         this.consumedCapacity = builder.consumedCapacity;
         this.itemCollectionMetrics = builder.itemCollectionMetrics;
+        this.responseMetadata = builder.responseMetadata;
     }
 
     /**
@@ -70,6 +73,14 @@ public ItemCollectionMetrics itemCollectionMetrics() {
         return itemCollectionMetrics;
     }
 
+    /**
+     * The response metadata, f.e. requestId
+     * @see UpdateItemResponse#responseMetadata() ()
+     */
+    public DynamoDbResponseMetadata responseMetadata() {
+        return responseMetadata;
+    }
+
     public static <T> Builder<T> builder(Class<? extends T> clzz) {
         return new Builder<>();
     }
@@ -86,14 +97,16 @@ public boolean equals(Object o) {
         UpdateItemEnhancedResponse<?> that = (UpdateItemEnhancedResponse<?>) o;
         return Objects.equals(attributes, that.attributes)
                && Objects.equals(consumedCapacity, that.consumedCapacity)
-               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics);
+               && Objects.equals(itemCollectionMetrics, that.itemCollectionMetrics)
+               && Objects.equals(responseMetadata, that.responseMetadata);
     }
 
     @Override
     public int hashCode() {
         int result = Objects.hashCode(attributes);
         result = 31 * result + Objects.hashCode(consumedCapacity);
         result = 31 * result + Objects.hashCode(itemCollectionMetrics);
+        result = 31 * result + Objects.hashCode(responseMetadata);
         return result;
     }
 
@@ -102,6 +115,7 @@ public static final class Builder<T> {
         private T attributes;
         private ConsumedCapacity consumedCapacity;
         private ItemCollectionMetrics itemCollectionMetrics;
+        private DynamoDbResponseMetadata responseMetadata;
 
         public Builder<T> attributes(T attributes) {
             this.attributes = attributes;
@@ -118,6 +132,11 @@ public Builder<T> itemCollectionMetrics(ItemCollectionMetrics itemCollectionMetr
             return this;
         }
 
+        public Builder<T> responseMetadata(DynamoDbResponseMetadata responseMetadata) {
+            this.responseMetadata = responseMetadata;
+            return this;
+        }
+
         public UpdateItemEnhancedResponse<T> build() {
             return new UpdateItemEnhancedResponse<>(this);
         }

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/AsyncBasicCrudTest.java

@@ -18,6 +18,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
 import static org.hamcrest.Matchers.nullValue;
 import static software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues.stringValue;
 import static software.amazon.awssdk.enhanced.dynamodb.mapper.StaticAttributeTags.primaryPartitionKey;
@@ -40,9 +41,12 @@
 import software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbEnhancedAsyncClient;
 import software.amazon.awssdk.enhanced.dynamodb.mapper.StaticTableSchema;
 import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
+import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedResponse;
 import software.amazon.awssdk.enhanced.dynamodb.model.EnhancedGlobalSecondaryIndex;
 import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
+import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedResponse;
 import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest;
+import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedResponse;
 import software.amazon.awssdk.services.dynamodb.model.ConditionalCheckFailedException;
 import software.amazon.awssdk.services.dynamodb.model.DeleteTableRequest;
 import software.amazon.awssdk.services.dynamodb.model.ProjectionType;
@@ -256,6 +260,19 @@ public void putThenGetItemUsingKey() {
         assertThat(result, is(record));
     }
 
+    @Test
+    public void putReturnsRequestId() {
+        Record record = new Record()
+            .setId("id-value")
+            .setSort("sort-value")
+            .setAttribute("one")
+            .setAttribute2("two")
+            .setAttribute3("three");
+
+        PutItemEnhancedResponse<Record> putResponse = mappedTable.putItemWithResponse(r -> r.item(record)).join();
+        assertThat(putResponse.responseMetadata().requestId(), notNullValue());
+    }
+
     @Test
     public void putThenGetItemUsingKeyItem() {
         Record record = new Record()
@@ -401,6 +418,13 @@ public void putWithConditionThatFails() {
                    .join();
     }
 
+    @Test
+    public void deleteReturnsRequestId() {
+        DeleteItemEnhancedResponse<Record> deleteResponse =
+            mappedTable.deleteItemWithResponse(r -> r.key(k -> k.partitionValue("id-value").sortValue("sort-value"))).join();
+        assertThat(deleteResponse.responseMetadata().requestId(), notNullValue());
+    }
+
     @Test
     public void deleteNonExistentItem() {
         Record result = mappedTable.deleteItem(r -> r.key(k -> k.partitionValue("id-value").sortValue("sort-value"))).join();
@@ -463,6 +487,20 @@ public void deleteWithConditionThatFails() {
                                                         .build()).join();
     }
 
+    @Test
+    public void updateReturnsRequestId() {
+        Record record = new Record()
+            .setId("id-value")
+            .setSort("sort-value")
+            .setAttribute("one")
+            .setAttribute2("two")
+            .setAttribute3("three");
+
+        UpdateItemEnhancedResponse<Record> updateResponse =
+            mappedTable.updateItemWithResponse(r -> r.item(record)).join();
+        assertThat(updateResponse.responseMetadata().requestId(), notNullValue());
+    }
+
     @Test
     public void updateOverwriteCompleteRecord_usingShortcutForm() {
         Record record = new Record()