com.amazonaws.services.dynamodbv2.model
Class BatchGetItemResult

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

All Implemented Interfaces:

java.io.Serializable

public class BatchGetItemResult
extends java.lang.Object
implements java.io.Serializable

Represents the output of a BatchGetItem operation.

See Also:

Serialized Form

Constructor Summary

BatchGetItemResult()

Method Summary

BatchGetItemResult	addResponsesEntry(java.lang.String key, java.util.List<java.util.Map<java.lang.String,AttributeValue>> value) A map of table name to a list of items.
BatchGetItemResult	addUnprocessedKeysEntry(java.lang.String key, KeysAndAttributes value) A map of tables and their respective keys that were not processed with the current response.
BatchGetItemResult	clearResponsesEntries() Removes all the entries added into Responses.
BatchGetItemResult	clearUnprocessedKeysEntries() Removes all the entries added into UnprocessedKeys.
boolean	equals(java.lang.Object obj)
java.util.List<ConsumedCapacity>	getConsumedCapacity() The write capacity units consumed by the operation.
java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>>	getResponses() A map of table name to a list of items.
java.util.Map<java.lang.String,KeysAndAttributes>	getUnprocessedKeys() A map of tables and their respective keys that were not processed with the current response.
int	hashCode()
void	setConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity) The write capacity units consumed by the operation.
void	setResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses) A map of table name to a list of items.
void	setUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
BatchGetItemResult	withConsumedCapacity(java.util.Collection<ConsumedCapacity> consumedCapacity) The write capacity units consumed by the operation.
BatchGetItemResult	withConsumedCapacity(ConsumedCapacity... consumedCapacity) The write capacity units consumed by the operation.
BatchGetItemResult	withResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses) A map of table name to a list of items.
BatchGetItemResult	withUnprocessedKeys(java.util.Map<java.lang.String,KeysAndAttributes> unprocessedKeys) A map of tables and their respective keys that were not processed with the current response.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchGetItemResult

public BatchGetItemResult()

Method Detail

getResponses

public java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> getResponses()

A map of table name to a list of items. Each object in Responses consists 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 Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

setResponses

public void setResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)

A map of table name to a list of items. Each object in Responses consists 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 Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

withResponses

public BatchGetItemResult withResponses(java.util.Map<java.lang.String,java.util.List<java.util.Map<java.lang.String,AttributeValue>>> responses)

A map of table name to a list of items. Each object in Responses consists 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 Responses consists 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.

addResponsesEntry

public BatchGetItemResult addResponsesEntry(java.lang.String key,
                                            java.util.List<java.util.Map<java.lang.String,AttributeValue>> value)

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

The method adds a new key-value pair into Responses parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Responses.

value - The corresponding value of the entry to be added into Responses.

clearResponsesEntries

public BatchGetItemResult clearResponsesEntries()

Removes all the entries added into Responses.

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

getUnprocessedKeys

public java.util.Map<java.lang.String,KeysAndAttributes> getUnprocessedKeys()

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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

Constraints:
Length: 1 - 100

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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

setUnprocessedKeys

public void setUnprocessedKeys(java.util.Map<java.lang.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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

Constraints:
Length: 1 - 100

Parameters:

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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

withUnprocessedKeys

public BatchGetItemResult withUnprocessedKeys(java.util.Map<java.lang.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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

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

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

Returns:

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

addUnprocessedKeysEntry

public BatchGetItemResult addUnprocessedKeysEntry(java.lang.String key,
                                                  KeysAndAttributes value)

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.

• AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified 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.

The method adds a new key-value pair into UnprocessedKeys parameter, and returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

key - The key of the entry to be added into UnprocessedKeys.

value - The corresponding value of the entry to be added into UnprocessedKeys.

clearUnprocessedKeysEntries

public BatchGetItemResult clearUnprocessedKeysEntries()

Removes all the entries added into UnprocessedKeys.

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

getConsumedCapacity

public java.util.List<ConsumedCapacity> getConsumedCapacity()

The write 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 write 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(java.util.Collection<ConsumedCapacity> consumedCapacity)

The write 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 write 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 write 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 write 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(java.util.Collection<ConsumedCapacity> consumedCapacity)

The write 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 write 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 java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object