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

Class BatchGetItemResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse
software.amazon.awssdk.services.dynamodb.model.BatchGetItemResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>
@Generated("software.amazon.awssdk:codegen") public final class BatchGetItemResponse extends DynamoDbResponse implements ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>

Represents the output of a BatchGetItem operation.

  • Method Details

    • hasResponses

      public final boolean hasResponses()
      For responses, this returns true if the service returned a value for the Responses 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.

    • responses

      public final Map<String,List<Map<String,AttributeValue>>> responses()

      A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

      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 hasResponses() method.

      Returns:
      A map of table name or table ARN to a list of items. Each object in Responses consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.

    • hasUnprocessedKeys

      public final boolean hasUnprocessedKeys()
      For responses, this returns true if the service returned a value for the UnprocessedKeys 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.

    • unprocessedKeys

      public final Map<String,KeysAndAttributes> unprocessedKeys()

      A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

      Each element consists of:

      • Keys - An array of primary key attribute values that define specific items in the table.

      • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

      • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys 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 hasUnprocessedKeys() method.

      Returns:
      A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

      Each element consists of:

      • Keys - An array of primary key attribute values that define specific items in the table.

      • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

      • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

    • 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 read capacity units consumed by the entire BatchGetItem 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 read capacity units consumed by the entire BatchGetItem operation.

      Each element consists of:

      • TableName - The table that consumed the provisioned throughput.

      • CapacityUnits - The total number of capacity units consumed.

    • toBuilder

      public BatchGetItemResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<BatchGetItemResponse.Builder,BatchGetItemResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static BatchGetItemResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchGetItemResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo