public class ScanRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable
Scan operation
.
The Scan operation returns one or more items and item attributes by accessing every item in the table. To have DynamoDB return fewer items, you can provide a ScanFilter operation.
If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.
The result set is eventually consistent.
By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel Scan operation by specifying the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide .
Constructor and Description |
---|
ScanRequest()
Default constructor for a new ScanRequest object.
|
ScanRequest(String tableName)
Constructs a new ScanRequest object.
|
Modifier and Type | Method and Description |
---|---|
ScanRequest |
addExclusiveStartKeyEntry(String key,
AttributeValue value)
The primary key of the first item that this operation will evaluate.
|
ScanRequest |
addExpressionAttributeNamesEntry(String key,
String value)
One or more substitution tokens for simplifying complex expressions.
|
ScanRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
ScanRequest |
addScanFilterEntry(String key,
Condition value)
|
ScanRequest |
clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey.
|
ScanRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
ScanRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
ScanRequest |
clearScanFilterEntries()
Removes all the entries added into ScanFilter.
|
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
|
String |
getConditionalOperator()
|
Map<String,AttributeValue> |
getExclusiveStartKey()
The primary key of the first item that this operation will evaluate.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for simplifying complex expressions.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
String |
getFilterExpression()
A condition that evaluates the scan results and returns only the
desired values.
|
Integer |
getLimit()
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
String |
getProjectionExpression()
One or more attributes to retrieve from the table.
|
String |
getReturnConsumedCapacity()
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
Map<String,Condition> |
getScanFilter()
|
Integer |
getSegment()
For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker.
|
String |
getSelect()
The attributes to be returned in the result.
|
String |
getTableName()
The name of the table containing the requested items.
|
Integer |
getTotalSegments()
For a parallel Scan request, TotalSegments represents
the total number of segments into which the Scan operation will
be divided.
|
int |
hashCode() |
void |
setAttributesToGet(Collection<String> attributesToGet)
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
|
void |
setConditionalOperator(String conditionalOperator)
|
void |
setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for simplifying complex expressions.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setFilterExpression(String filterExpression)
A condition that evaluates the scan results and returns only the
desired values.
|
void |
setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
void |
setProjectionExpression(String projectionExpression)
One or more attributes to retrieve from the table.
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
void |
setScanFilter(Map<String,Condition> scanFilter)
|
void |
setSegment(Integer segment)
For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker.
|
void |
setSelect(Select select)
The attributes to be returned in the result.
|
void |
setSelect(String select)
The attributes to be returned in the result.
|
void |
setTableName(String tableName)
The name of the table containing the requested items.
|
void |
setTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents
the total number of segments into which the Scan operation will
be divided.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ScanRequest |
withAttributesToGet(Collection<String> attributesToGet)
|
ScanRequest |
withAttributesToGet(String... attributesToGet)
|
ScanRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
ScanRequest |
withConditionalOperator(String conditionalOperator)
|
ScanRequest |
withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary key of the first item that this operation will evaluate.
|
ScanRequest |
withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
ScanRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for simplifying complex expressions.
|
ScanRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
ScanRequest |
withFilterExpression(String filterExpression)
A condition that evaluates the scan results and returns only the
desired values.
|
ScanRequest |
withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
ScanRequest |
withProjectionExpression(String projectionExpression)
One or more attributes to retrieve from the table.
|
ScanRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
ScanRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
ScanRequest |
withScanFilter(Map<String,Condition> scanFilter)
|
ScanRequest |
withSegment(Integer segment)
For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker.
|
ScanRequest |
withSelect(Select select)
The attributes to be returned in the result.
|
ScanRequest |
withSelect(String select)
The attributes to be returned in the result.
|
ScanRequest |
withTableName(String tableName)
The name of the table containing the requested items.
|
ScanRequest |
withTotalSegments(Integer totalSegments)
For a parallel Scan request, TotalSegments represents
the total number of segments into which the Scan operation will
be divided.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public ScanRequest()
public ScanRequest(String tableName)
tableName
- The name of the table containing the requested items.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 name of the table containing the requested items.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 name of the table containing the requested items.public List<String> getAttributesToGet()
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
public void setAttributesToGet(Collection<String> attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
attributesToGet
- There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
public ScanRequest withAttributesToGet(String... attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet
- There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
public ScanRequest withAttributesToGet(Collection<String> attributesToGet)
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
attributesToGet
- There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
public Integer getLimit()
Constraints:
Range: 1 -
public void setLimit(Integer limit)
Constraints:
Range: 1 -
limit
- The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in
LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed data set
size exceeds 1 MB before DynamoDB reaches this limit, it stops the
operation and returns the matching values up to the limit, and a key
in LastEvaluatedKey to apply in a subsequent operation to
continue the operation. For more information, see Query
and Scan in the Amazon DynamoDB Developer Guide.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 evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in
LastEvaluatedKey to apply in a subsequent operation, so that
you can pick up where you left off. Also, if the processed data set
size exceeds 1 MB before DynamoDB reaches this limit, it stops the
operation and returns the matching values up to the limit, and a key
in LastEvaluatedKey to apply in a subsequent operation to
continue the operation. For more information, see Query
and Scan in the Amazon DynamoDB Developer Guide.public String getSelect()
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Select
public void setSelect(String select)
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Select
public ScanRequest withSelect(String select)
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Select
public void setSelect(Select select)
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Select
public ScanRequest withSelect(Select select)
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, or the count of matching items.
ALL_ATTRIBUTES
- Returns all of the item
attributes.
COUNT
- Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES
. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Select
public Map<String,Condition> getScanFilter()
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
public void setScanFilter(Map<String,Condition> scanFilter)
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
scanFilter
- There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
public ScanRequest withScanFilter(Map<String,Condition> scanFilter)
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
Returns a reference to this object so that method calls can be chained together.
scanFilter
- There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
public ScanRequest addScanFilterEntry(String key, Condition value)
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a
is greater than
A
, and aa
is greater than B
.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
The method adds a new key-value pair into ScanFilter parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ScanFilter.value
- The corresponding value of the entry to be added into ScanFilter.public ScanRequest clearScanFilterEntries()
Returns a reference to this object so that method calls can be chained together.
public String getConditionalOperator()
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperator
public void setConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
conditionalOperator
- There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperator
public ScanRequest withConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
- There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
conditionalOperator
- There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperator
public ScanRequest withConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator
- There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND
- If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR
- If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is
the default.
The operation will succeed only if the entire map evaluates to true.
ConditionalOperator
public Map<String,AttributeValue> getExclusiveStartKey()
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
public void setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
exclusiveStartKey
- The primary key of the first item that this operation will evaluate.
Use the value that was returned for LastEvaluatedKey in the
previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
public ScanRequest withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
Returns a reference to this object so that method calls can be chained together.
exclusiveStartKey
- The primary key of the first item that this operation will evaluate.
Use the value that was returned for LastEvaluatedKey in the
previous operation. The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
public void setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
This method accepts the hashKey, rangeKey of ExclusiveStartKey as
java.util.Map.Entry
hashKey
- Primary hash key.rangeKey
- Primary range key. (null if it a hash-only table)IllegalArgumentException
public ScanRequest withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
This method accepts the hashKey, rangeKey of ExclusiveStartKey as
java.util.Map.Entry
Returns a reference to this object so that method calls can be chained together.
hashKey
- Primary hash key.rangeKey
- Primary range key. (null if it a hash-only table)IllegalArgumentException
public ScanRequest addExclusiveStartKeyEntry(String key, AttributeValue value)
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
The method adds a new key-value pair into ExclusiveStartKey parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ExclusiveStartKey.value
- The corresponding value of the entry to be added into ExclusiveStartKey.public ScanRequest clearExclusiveStartKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public String getReturnConsumedCapacity()
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacity
public void setReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- A value that if set to TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacity
public ScanRequest withReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- A value that if set to TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- A value that if set to TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacity
public ScanRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- A value that if set to TOTAL
, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES
, the response includes ConsumedCapacity
for indexes. If set to NONE
(the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacity
public Integer getTotalSegments()
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
public void setTotalSegments(Integer totalSegments)
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
totalSegments
- For a parallel Scan request, TotalSegments represents
the total number of segments into which the Scan operation will
be divided. The value of TotalSegments corresponds to the
number of application workers that will perform the parallel scan. For
example, if you want to scan a table using four application threads,
specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
public ScanRequest withTotalSegments(Integer totalSegments)
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 1000000
totalSegments
- For a parallel Scan request, TotalSegments represents
the total number of segments into which the Scan operation will
be divided. The value of TotalSegments corresponds to the
number of application workers that will perform the parallel scan. For
example, if you want to scan a table using four application threads,
specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
public Integer getSegment()
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 999999
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
public void setSegment(Integer segment)
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 999999
segment
- For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
public ScanRequest withSegment(Integer segment)
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 999999
segment
- For a parallel Scan request, Segment identifies an
individual segment to be scanned by an application worker. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
public String getProjectionExpression()
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
public void setProjectionExpression(String projectionExpression)
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
projectionExpression
- One or more attributes to retrieve from the table. These attributes
can include scalars, sets, or elements of a JSON document. The
attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
public ScanRequest withProjectionExpression(String projectionExpression)
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Returns a reference to this object so that method calls can be chained together.
projectionExpression
- One or more attributes to retrieve from the table. These attributes
can include scalars, sets, or elements of a JSON document. The
attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
public String getFilterExpression()
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
public void setFilterExpression(String filterExpression)
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
filterExpression
- A condition that evaluates the scan results and returns only the
desired values. The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
public ScanRequest withFilterExpression(String filterExpression)
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
Returns a reference to this object so that method calls can be chained together.
filterExpression
- A condition that evaluates the scan results and returns only the
desired values. The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
public Map<String,String> getExpressionAttributeNames()
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
expressionAttributeNames
- One or more substitution tokens for simplifying complex expressions.
The following are some use cases for an
ExpressionAttributeNames value: To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public ScanRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
Returns a reference to this object so that method calls can be chained together.
expressionAttributeNames
- One or more substitution tokens for simplifying complex expressions.
The following are some use cases for an
ExpressionAttributeNames value: To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
public ScanRequest addExpressionAttributeNamesEntry(String key, String value)
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ExpressionAttributeNames.value
- The corresponding value of the entry to be added into ExpressionAttributeNames.public ScanRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,AttributeValue> getExpressionAttributeValues()
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
expressionAttributeValues
- One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public ScanRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
Returns a reference to this object so that method calls can be chained together.
expressionAttributeValues
- One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
public ScanRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ExpressionAttributeValues.value
- The corresponding value of the entry to be added into ExpressionAttributeValues.public ScanRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.