com.amazonaws.services.dynamodbv2.model
Class BatchGetItemResult

java.lang.Object
  com.amazonaws.services.dynamodbv2.model.BatchGetItemResult

All Implemented Interfaces:

Serializable

public class BatchGetItemResult
extends Object
implements Serializable

Represents the output of a BatchGetItem operation.

See Also:

Serialized Form

Constructor Summary

BatchGetItemResult()

Method Summary

boolean	equals(Object obj)
List<ConsumedCapacity>	getConsumedCapacity() The capacity units consumed by the operation.
Map<String,List<Map<String,AttributeValue>>>	getResponses() A map of table name to a list of items.
Map<String,KeysAndAttributes>	getUnprocessedKeys() A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size.
int	hashCode()
void	setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity) The capacity units consumed by the operation.
void	setResponses(Map<String,List<Map<String,AttributeValue>>> responses) A map of table name to a list of items.
void	setUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size.
String	toString() Returns a string representation of this object; useful for testing and debugging.
BatchGetItemResult	withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity) The capacity units consumed by the operation.
BatchGetItemResult	withConsumedCapacity(ConsumedCapacity... consumedCapacity) The capacity units consumed by the operation.
BatchGetItemResult	withResponses(Map<String,List<Map<String,AttributeValue>>> responses) A map of table name to a list of items.
BatchGetItemResult	withUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchGetItemResult

public BatchGetItemResult()

Method Detail

getResponses

public Map<String,List<Map<String,AttributeValue>>> getResponses()

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

Returns:

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

setResponses

public void setResponses(Map<String,List<Map<String,AttributeValue>>> responses)

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

Parameters:

responses - A map of table name to a list of items. Each object in Responsesconsists of a table name, along with a map of attribute data consisting of the data type and attribute value.

withResponses

public BatchGetItemResult withResponses(Map<String,List<Map<String,AttributeValue>>> responses)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

responses - A map of table name to a list of items. Each object in Responsesconsists of a table name, along with a map of attribute data consisting of the data type and attribute value.

Returns:

A reference to this updated object so that method calls can be chained together.

getUnprocessedKeys

public Map<String,KeysAndAttributes> getUnprocessedKeys()

A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

Constraints:
Length: 1 - 100

Returns:

A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

setUnprocessedKeys

public void setUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)

A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

Constraints:
Length: 1 - 100

Parameters:

unprocessedKeys - A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

withUnprocessedKeys

public BatchGetItemResult withUnprocessedKeys(Map<String,KeysAndAttributes> unprocessedKeys)

A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

unprocessedKeys - A map of tables and their respective keys that were not processed with the current response, possibly due to reaching a limit on the response size. 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-The primary key attribute values that define the items and the attributes associated with the items.

• AttributesToGet-One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

  If you are querying an index and only request attributes that are projected into that index, the operation will consult the index and bypass the table. If any of the requested attributes are not projected into the index, Amazon DynamoDB will need to fetch each matching item from the table. This extra fetching incurs additional throughput cost and latency.

• 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getConsumedCapacity

public List<ConsumedCapacity> getConsumedCapacity()

The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Returns:

The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

setConsumedCapacity

public void setConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)

The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

withConsumedCapacity

public BatchGetItemResult withConsumedCapacity(ConsumedCapacity... consumedCapacity)

The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Returns:

A reference to this updated object so that method calls can be chained together.

withConsumedCapacity

public BatchGetItemResult withConsumedCapacity(Collection<ConsumedCapacity> consumedCapacity)

The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

consumedCapacity - The capacity units consumed by the operation.

Each element consists of:

• TableName-The table that consumed the provisioned throughput.

• CapacityUnits-The total number of capacity units consumed.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object