com.amazonaws.services.dynamodb.model
Class ScanResult

java.lang.Object
  com.amazonaws.services.dynamodb.model.ScanResult

public class ScanResult
extends Object

Scan Result

Constructor Summary

ScanResult()

Method Summary

boolean	equals(Object obj)
Double	getConsumedCapacityUnits() The number of Capacity Units of the provisioned throughput of the table consumed during the operation.
Integer	getCount() Number of items in the response.
List<Map<String,AttributeValue>>	getItems() Returns the value of the Items property for this object.
Key	getLastEvaluatedKey() Primary key of the item where the scan operation stopped.
Integer	getScannedCount() Number of items in the complete scan before any filters are applied.
int	hashCode()
void	setConsumedCapacityUnits(Double consumedCapacityUnits) The number of Capacity Units of the provisioned throughput of the table consumed during the operation.
void	setCount(Integer count) Number of items in the response.
void	setItems(Collection<Map<String,AttributeValue>> items) Sets the value of the Items property for this object.
void	setLastEvaluatedKey(Key lastEvaluatedKey) Primary key of the item where the scan operation stopped.
void	setScannedCount(Integer scannedCount) Number of items in the complete scan before any filters are applied.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ScanResult	withConsumedCapacityUnits(Double consumedCapacityUnits) The number of Capacity Units of the provisioned throughput of the table consumed during the operation.
ScanResult	withCount(Integer count) Number of items in the response.
ScanResult	withItems(Collection<Map<String,AttributeValue>> items) Sets the value of the Items property for this object.
ScanResult	withItems(Map<String,AttributeValue>... items) Sets the value of the Items property for this object.
ScanResult	withLastEvaluatedKey(Key lastEvaluatedKey) Primary key of the item where the scan operation stopped.
ScanResult	withScannedCount(Integer scannedCount) Number of items in the complete scan before any filters are applied.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScanResult

public ScanResult()

Method Detail

getItems

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

Returns the value of the Items property for this object.

Returns:

The value of the Items property for this object.

setItems

public void setItems(Collection<Map<String,AttributeValue>> items)

Sets the value of the Items property for this object.

Parameters:

items - The new value for the Items property for this object.

withItems

public ScanResult withItems(Map<String,AttributeValue>... items)

Sets the value of the Items property for this object.

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

Parameters:

items - The new value for the Items property for this object.

Returns:

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

withItems

public ScanResult withItems(Collection<Map<String,AttributeValue>> items)

Sets the value of the Items property for this object.

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

Parameters:

items - The new value for the Items property for this object.

Returns:

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

getCount

public Integer getCount()

Number of items in the response.

Returns:

Number of items in the response.

setCount

public void setCount(Integer count)

Number of items in the response.

Parameters:

count - Number of items in the response.

withCount

public ScanResult withCount(Integer count)

Number of items in the response.

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

Parameters:

count - Number of items in the response.

Returns:

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

getScannedCount

public Integer getScannedCount()

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

Returns:

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

setScannedCount

public void setScannedCount(Integer scannedCount)

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

Parameters:

scannedCount - Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

withScannedCount

public ScanResult withScannedCount(Integer scannedCount)

Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

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

Parameters:

scannedCount - Number of items in the complete scan before any filters are applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation.

Returns:

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

getLastEvaluatedKey

public Key getLastEvaluatedKey()

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

Returns:

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

setLastEvaluatedKey

public void setLastEvaluatedKey(Key lastEvaluatedKey)

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

Parameters:

lastEvaluatedKey - Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

withLastEvaluatedKey

public ScanResult withLastEvaluatedKey(Key lastEvaluatedKey)

Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

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

Parameters:

lastEvaluatedKey - Primary key of the item where the scan operation stopped. Provide this value in a subsequent scan operation to continue the operation from that point. The LastEvaluatedKey is null when the entire scan result set is complete (i.e. the operation processed the "last page").

Returns:

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

getConsumedCapacityUnits

public Double getConsumedCapacityUnits()

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Returns:

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

setConsumedCapacityUnits

public void setConsumedCapacityUnits(Double consumedCapacityUnits)

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

Parameters:

consumedCapacityUnits - The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

withConsumedCapacityUnits

public ScanResult withConsumedCapacityUnits(Double consumedCapacityUnits)

The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

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

Parameters:

consumedCapacityUnits - The number of Capacity Units of the provisioned throughput of the table consumed during the operation. GetItem, BatchGetItem, BatchWriteItem, Query, and Scan operations consume ReadCapacityUnits, while PutItem, UpdateItem, and DeleteItem operations consume WriteCapacityUnits.

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