|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.dynamodb.model.ScanRequest
public class ScanRequest
Container for the parameters to the Scan operation
.
The Scan operation returns one or more items and its attributes by performing a full scan of a table. Limit the returned results by specifying a filter.
AmazonDynamoDB.scan(ScanRequest)
Constructor Summary | |
---|---|
ScanRequest()
Default constructor for a new ScanRequest object. |
|
ScanRequest(String tableName)
Constructs a new ScanRequest object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
List<String> |
getAttributesToGet()
Array of Attribute names. |
Boolean |
getCount()
If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. |
Key |
getExclusiveStartKey()
Primary key of the item from which to continue an earlier scan. |
Integer |
getLimit()
The maximum number of items to return. |
Map<String,Condition> |
getScanFilter()
Evaluates the scan results and returns only the desired values. |
String |
getTableName()
Returns the value of the TableName property for this object. |
int |
hashCode()
|
Boolean |
isCount()
If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. |
void |
setAttributesToGet(Collection<String> attributesToGet)
Array of Attribute names. |
void |
setCount(Boolean count)
If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. |
void |
setExclusiveStartKey(Key exclusiveStartKey)
Primary key of the item from which to continue an earlier scan. |
void |
setLimit(Integer limit)
The maximum number of items to return. |
void |
setScanFilter(Map<String,Condition> scanFilter)
Evaluates the scan results and returns only the desired values. |
void |
setTableName(String tableName)
Sets the value of the TableName property for this object. |
String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
ScanRequest |
withAttributesToGet(Collection<String> attributesToGet)
Array of Attribute names. |
ScanRequest |
withAttributesToGet(String... attributesToGet)
Array of Attribute names. |
ScanRequest |
withCount(Boolean count)
If set to true, Amazon DynamoDB returns a total number of items for the Scan operation, even if the operation has no matching items for the assigned filter. |
ScanRequest |
withExclusiveStartKey(Key exclusiveStartKey)
Primary key of the item from which to continue an earlier scan. |
ScanRequest |
withLimit(Integer limit)
The maximum number of items to return. |
ScanRequest |
withScanFilter(Map<String,Condition> scanFilter)
Evaluates the scan results and returns only the desired values. |
ScanRequest |
withTableName(String tableName)
Sets the value of the TableName property for this object. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ScanRequest()
public ScanRequest(String tableName)
tableName
- Method Detail |
---|
public String getTableName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setTableName(String tableName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The new value for the TableName property for this object.public ScanRequest withTableName(String tableName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The new value for the TableName property for this object.
public List<String> getAttributesToGet()
Constraints:
Length: 1 -
public void setAttributesToGet(Collection<String> attributesToGet)
Constraints:
Length: 1 -
attributesToGet
- Array of Attribute names. If attribute names are not specified then
all attributes will be returned. If some attributes are not found,
they will not appear in the result.public ScanRequest withAttributesToGet(String... attributesToGet)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet
- Array of Attribute names. If attribute names are not specified then
all attributes will be returned. If some attributes are not found,
they will not appear in the result.
public ScanRequest withAttributesToGet(Collection<String> attributesToGet)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet
- Array of Attribute names. If attribute names are not specified then
all attributes will be returned. If some attributes are not found,
they will not appear in the result.
public Integer getLimit()
Constraints:
Range: 1 -
public void setLimit(Integer limit)
Constraints:
Range: 1 -
limit
- The maximum number of items to return. If Amazon DynamoDB hits this
limit while scanning the table, it stops the scan and returns the
matching values up to the limit, and a LastEvaluatedKey to apply in a
subsequent operation to continue the scan. Also, if the scanned data
set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops
the scan and returns the matching values up to the limit, and a
LastEvaluatedKey to apply in a subsequent operation to continue the
scan.public ScanRequest withLimit(Integer limit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
limit
- The maximum number of items to return. If Amazon DynamoDB hits this
limit while scanning the table, it stops the scan and returns the
matching values up to the limit, and a LastEvaluatedKey to apply in a
subsequent operation to continue the scan. Also, if the scanned data
set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops
the scan and returns the matching values up to the limit, and a
LastEvaluatedKey to apply in a subsequent operation to continue the
scan.
public Boolean isCount()
public void setCount(Boolean count)
count
- If set to true, Amazon DynamoDB returns a total number of items for
the Scan operation, even if the operation has no matching items for
the assigned filter. Do not set Count to true while providing a list
of AttributesToGet, otherwise Amazon DynamoDB returns a validation
error.public ScanRequest withCount(Boolean count)
Returns a reference to this object so that method calls can be chained together.
count
- If set to true, Amazon DynamoDB returns a total number of items for
the Scan operation, even if the operation has no matching items for
the assigned filter. Do not set Count to true while providing a list
of AttributesToGet, otherwise Amazon DynamoDB returns a validation
error.
public Boolean getCount()
public Map<String,Condition> getScanFilter()
public void setScanFilter(Map<String,Condition> scanFilter)
scanFilter
- Evaluates the scan results and returns only the desired values.public ScanRequest withScanFilter(Map<String,Condition> scanFilter)
Returns a reference to this object so that method calls can be chained together.
scanFilter
- Evaluates the scan results and returns only the desired values.
public Key getExclusiveStartKey()
public void setExclusiveStartKey(Key exclusiveStartKey)
exclusiveStartKey
- Primary key of the item from which to continue an earlier scan. An
earlier scan might provide this value if that scan operation was
interrupted before scanning the entire table; either because of the
result set size or the Limit parameter. The LastEvaluatedKey can be
passed back in a new scan request to continue the operation from that
point.public ScanRequest withExclusiveStartKey(Key exclusiveStartKey)
Returns a reference to this object so that method calls can be chained together.
exclusiveStartKey
- Primary key of the item from which to continue an earlier scan. An
earlier scan might provide this value if that scan operation was
interrupted before scanning the entire table; either because of the
result set size or the Limit parameter. The LastEvaluatedKey can be
passed back in a new scan request to continue the operation from that
point.
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |