Interface BatchGetItemResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<BatchGetItemResponse.Builder,
,BatchGetItemResponse> DynamoDbResponse.Builder
,SdkBuilder<BatchGetItemResponse.Builder,
,BatchGetItemResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
BatchGetItemResponse
-
Method Summary
Modifier and TypeMethodDescriptionconsumedCapacity
(Collection<ConsumedCapacity> consumedCapacity) The read capacity units consumed by the entireBatchGetItem
operation.consumedCapacity
(Consumer<ConsumedCapacity.Builder>... consumedCapacity) The read capacity units consumed by the entireBatchGetItem
operation.consumedCapacity
(ConsumedCapacity... consumedCapacity) The read capacity units consumed by the entireBatchGetItem
operation.responses
(Map<String, ? extends Collection<? extends Map<String, AttributeValue>>> responses) A map of table name or table ARN to a list of items.unprocessedKeys
(Map<String, KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
responses
BatchGetItemResponse.Builder responses(Map<String, ? extends Collection<? extends 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.- Parameters:
responses
- A map of table name or table ARN to a list of items. Each object inResponses
consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 asRequestItems
, so the value can be provided directly to a subsequentBatchGetItem
operation. For more information, seeRequestItems
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 totrue
, 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.- Parameters:
unprocessedKeys
- A map of tables and their respective keys that were not processed with the current response. TheUnprocessedKeys
value is in the same form asRequestItems
, so the value can be provided directly to a subsequentBatchGetItem
operation. For more information, seeRequestItems
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 totrue
, 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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
consumedCapacity
- The read capacity units consumed by the entireBatchGetItem
operation.Each element consists of:
-
TableName
- The table that consumed the provisioned throughput. -
CapacityUnits
- The total number of capacity units consumed.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
consumedCapacity
- The read capacity units consumed by the entireBatchGetItem
operation.Each element consists of:
-
TableName
- The table that consumed the provisioned throughput. -
CapacityUnits
- The total number of capacity units consumed.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
consumedCapacity
BatchGetItemResponse.Builder consumedCapacity(Consumer<ConsumedCapacity.Builder>... 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.
ConsumedCapacity.Builder
avoiding the need to create one manually viaConsumedCapacity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconsumedCapacity(List<ConsumedCapacity>)
.- Parameters:
consumedCapacity
- a consumer that will call methods onConsumedCapacity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-