Package software.amazon.awssdk.services.dynamodb.model

Class BatchWriteItemResponse

    • Method Detail

      • hasUnprocessedItems

        public final boolean hasUnprocessedItems()
        For responses, this returns true if the service returned a value for the UnprocessedItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • unprocessedItems

        public final Map<String,​List<WriteRequest>> unprocessedItems()

        A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchWriteItem operation. For more information, see RequestItems in the Request Parameters section.

        Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

        • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

          • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

        • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

          • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

            If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

        If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUnprocessedItems() method.

        Returns:
        A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchWriteItem operation. For more information, see RequestItems in the Request Parameters section.

        Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

        • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

          • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

        • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

          • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

            If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

        If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

      • hasItemCollectionMetrics

        public final boolean hasItemCollectionMetrics()
        For responses, this returns true if the service returned a value for the ItemCollectionMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • itemCollectionMetrics

        public final Map<String,​List<ItemCollectionMetrics>> itemCollectionMetrics()

        A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

        Each entry consists of the following subelements:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

        • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItemCollectionMetrics() method.

        Returns:
        A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

        Each entry consists of the following subelements:

        • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

        • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

          The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

      • hasConsumedCapacity

        public final boolean hasConsumedCapacity()
        For responses, this returns true if the service returned a value for the ConsumedCapacity property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • consumedCapacity

        public final List<ConsumedCapacity> consumedCapacity()

        The capacity units consumed by the entire BatchWriteItem operation.

        Each element consists of:

        • TableName - The table that consumed the provisioned throughput.

        • CapacityUnits - The total number of capacity units consumed.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConsumedCapacity() method.

        Returns:
        The capacity units consumed by the entire BatchWriteItem operation.

        Each element consists of:

        • TableName - The table that consumed the provisioned throughput.

        • CapacityUnits - The total number of capacity units consumed.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object