public class DynamoDBScanExpression
extends java.lang.Object
ComparisonOperator
for more
information on the available comparison types).Modifier and Type | Field and Description |
---|---|
private java.lang.String |
conditionalOperator
The logical operator on the filter conditions of this scan.
|
private java.lang.Boolean |
consistentRead |
private java.util.Map<java.lang.String,AttributeValue> |
exclusiveStartKey
The exclusive start key for this scan.
|
private java.util.Map<java.lang.String,java.lang.String> |
expressionAttributeNames
One or more substitution variables for simplifying complex
expressions.
|
private java.util.Map<java.lang.String,AttributeValue> |
expressionAttributeValues
One or more values that can be substituted in an expression.
|
private java.lang.String |
filterExpression
Evaluates the scan results and returns only the desired values.
|
private java.lang.String |
indexName
Optional index name that can be specified for the scan operation.
|
private java.lang.Integer |
limit
The limit of items to scan during this scan.
|
private java.lang.String |
projectionExpression
A string that identifies one or more attributes to retrieve from the
table.
|
private java.lang.String |
returnConsumedCapacity
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
private java.util.Map<java.lang.String,Condition> |
scanFilter
Optional filter to limit the results of the scan.
|
private java.lang.Integer |
segment
The ID (zero-based) of the segment to be scanned.
|
private java.lang.String |
select
The attributes to be returned in the result.
|
private java.lang.Integer |
totalSegments
The total number of segments into which the scan will be divided.
|
Constructor and Description |
---|
DynamoDBScanExpression() |
Modifier and Type | Method and Description |
---|---|
DynamoDBScanExpression |
addExpressionAttributeNamesEntry(java.lang.String key,
java.lang.String value)
One or more substitution variables for simplifying complex expressions.
|
DynamoDBScanExpression |
addExpressionAttributeValuesEntry(java.lang.String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
void |
addFilterCondition(java.lang.String attributeName,
Condition condition)
Adds a new filter condition to the current scan filter.
|
DynamoDBScanExpression |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
DynamoDBScanExpression |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
java.lang.String |
getConditionalOperator()
Returns the logical operator on the filter conditions of this scan.
|
java.util.Map<java.lang.String,AttributeValue> |
getExclusiveStartKey()
Returns the exclusive start key for this scan.
|
java.util.Map<java.lang.String,java.lang.String> |
getExpressionAttributeNames()
One or more substitution variables for simplifying complex expressions.
|
java.util.Map<java.lang.String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
java.lang.String |
getFilterExpression()
Evaluates the query results and returns only the desired values.
|
java.lang.String |
getIndexName()
Returns the name of the index to be used by this scan; or null if there
is none.
|
java.lang.Integer |
getLimit()
Returns the limit of items to scan during this scan.
|
java.lang.String |
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the
table.
|
java.lang.String |
getReturnConsumedCapacity()
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
java.util.Map<java.lang.String,Condition> |
getScanFilter()
Returns the scan filter as a map of attribute names to conditions.
|
java.lang.Integer |
getSegment()
Returns the ID of the segment to be scanned.
|
java.lang.String |
getSelect()
The attributes to be returned in the result.
|
java.lang.Integer |
getTotalSegments()
Returns the total number of segments into which the scan will be divided.
|
java.lang.Boolean |
isConsistentRead()
Returns whether this scan uses consistent reads.
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
Sets the logical operator on the filter conditions of this scan.
|
void |
setConditionalOperator(java.lang.String conditionalOperator)
Sets the logical operator on the filter conditions of this scan.
|
void |
setConsistentRead(java.lang.Boolean consistentRead)
Sets whether this scan uses consistent reads.
|
void |
setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
Sets the exclusive start key for this scan.
|
void |
setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution variables for simplifying complex expressions.
|
void |
setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setFilterExpression(java.lang.String filterExpression)
Evaluates the query results and returns only the desired values.
|
void |
setIndexName(java.lang.String indexName)
Sets the name of the index to be used by this scan.
|
void |
setLimit(java.lang.Integer limit)
Sets the limit of items to scan during this scan.
|
void |
setProjectionExpression(java.lang.String projectionExpression)
A string that identifies 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(java.lang.String returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
void |
setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
Sets the scan filter to the map of attribute names to conditions given.
|
void |
setSegment(java.lang.Integer segment)
Sets the ID of the segment to be scanned.
|
void |
setSelect(Select select)
The attributes to be returned in the result.
|
void |
setSelect(java.lang.String select)
The attributes to be returned in the result.
|
void |
setTotalSegments(java.lang.Integer totalSegments)
Sets the total number of segments into which the scan will be divided.
|
DynamoDBScanExpression |
withConditionalOperator(ConditionalOperator conditionalOperator)
Sets the logical operator on the filter conditions of this scan and
returns a pointer to this object for method-chaining.
|
DynamoDBScanExpression |
withConditionalOperator(java.lang.String conditionalOperator)
Sets the logical operator on the filter conditions of this scan and
returns a pointer to this object for method-chaining.
|
DynamoDBScanExpression |
withConsistentRead(java.lang.Boolean consistentRead)
Sets whether this scan uses consistent reads and returns a reference
to this object for method chaining.
|
DynamoDBScanExpression |
withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
Sets the exclusive start key for this scan and returns a pointer to this
object for method-chaining.
|
DynamoDBScanExpression |
withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution variables for simplifying complex expressions.
|
DynamoDBScanExpression |
withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
DynamoDBScanExpression |
withFilterConditionEntry(java.lang.String attributeName,
Condition condition)
Adds a new filter condition to the current scan filter and returns a
pointer to this object for method-chaining.
|
DynamoDBScanExpression |
withFilterExpression(java.lang.String filterExpression)
Evaluates the query results and returns only the desired values.
|
DynamoDBScanExpression |
withIndexName(java.lang.String indexName)
Sets the name of the index to be used by this scan.
|
DynamoDBScanExpression |
withLimit(java.lang.Integer limit)
Sets the limit of items to scan and returns a pointer to this object for
method-chaining.
|
DynamoDBScanExpression |
withProjectionExpression(java.lang.String projectionExpression)
A string that identifies one or more attributes to retrieve from the
table.
|
DynamoDBScanExpression |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
DynamoDBScanExpression |
withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
DynamoDBScanExpression |
withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
Sets the scan filter to the map of attribute names to conditions given
and returns a pointer to this object for method-chaining.
|
DynamoDBScanExpression |
withSegment(java.lang.Integer segment)
Sets the ID of the segment to be scanned and returns a pointer to this
object for method-chaining.
|
DynamoDBScanExpression |
withSelect(Select select)
The attributes to be returned in the result.
|
DynamoDBScanExpression |
withSelect(java.lang.String select)
The attributes to be returned in the result.
|
DynamoDBScanExpression |
withTotalSegments(java.lang.Integer totalSegments)
Sets the total number of segments into which the scan will be divided and
returns a pointer to this object for method-chaining.
|
private java.util.Map<java.lang.String,Condition> scanFilter
private java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey
private java.lang.Integer limit
private java.lang.Integer totalSegments
private java.lang.Integer segment
private java.lang.String conditionalOperator
private java.lang.String filterExpression
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
private java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames
Shorten an attribute name that is very long or unwieldy in an expression.
Create a placeholder for repeating occurrences of an attribute name in an expression.
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"
private java.util.Map<java.lang.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)
private java.lang.String select
ALL_ATTRIBUTES
- Returns all of
the item attributes from the specified table or index. If you query a
local secondary index, then for each matching item in the index
DynamoDB will fetch the entire item from the parent table. If the
index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching
is required.
ALL_PROJECTED_ATTRIBUTES
-
Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to
project all attributes, this return value is equivalent to specifying
ALL_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 you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES
when
accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and
AttributesToGet 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
private java.lang.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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
private java.lang.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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
private java.lang.String indexName
private java.lang.Boolean consistentRead
public java.lang.String getIndexName()
public void setIndexName(java.lang.String indexName)
public DynamoDBScanExpression withIndexName(java.lang.String indexName)
Returns a pointer to this object for method-chaining.
public java.util.Map<java.lang.String,Condition> getScanFilter()
public void setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
scanFilter
- The map of attribute names to conditions to use when filtering
scan results.public DynamoDBScanExpression withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)
scanFilter
- The map of attribute names to conditions to use when filtering
scan results.public void addFilterCondition(java.lang.String attributeName, Condition condition)
attributeName
- The name of the attribute on which the specified condition
operates.condition
- The condition which describes how the specified attribute is
compared and if a row of data is included in the results
returned by the scan operation.public DynamoDBScanExpression withFilterConditionEntry(java.lang.String attributeName, Condition condition)
attributeName
- The name of the attribute on which the specified condition
operates.condition
- The condition which describes how the specified attribute is
compared and if a row of data is included in the results
returned by the scan operation.public java.util.Map<java.lang.String,AttributeValue> getExclusiveStartKey()
public void setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
public DynamoDBScanExpression withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
public java.lang.Integer getLimit()
Use with caution. Please note that this is not the same as the
number of items to return from the scan operation -- the operation will
cease and return as soon as this many items are scanned, even if no
matching results are found. Furthermore, PaginatedScanList
will
execute as many scan operations as necessary until it either reaches the
end of the result set as indicated by DynamoDB or enough elements are
available to fulfill the list operation (e.g. iteration). Therefore,
except when scanning without a scan filter, it's usually bad practice to
set a low limit, since doing so will often generate the same amount of
traffic to DynamoDB but with a greater number of round trips and
therefore more overall latency.
public void setLimit(java.lang.Integer limit)
getLimit()
public DynamoDBScanExpression withLimit(java.lang.Integer limit)
getLimit()
public java.lang.Integer getTotalSegments()
public void setTotalSegments(java.lang.Integer totalSegments)
public DynamoDBScanExpression withTotalSegments(java.lang.Integer totalSegments)
public java.lang.Integer getSegment()
public void setSegment(java.lang.Integer segment)
public DynamoDBScanExpression withSegment(java.lang.Integer segment)
public java.lang.String getConditionalOperator()
public void setConditionalOperator(java.lang.String conditionalOperator)
public DynamoDBScanExpression withConditionalOperator(java.lang.String conditionalOperator)
public void setConditionalOperator(ConditionalOperator conditionalOperator)
public DynamoDBScanExpression withConditionalOperator(ConditionalOperator conditionalOperator)
public java.lang.String getFilterExpression()
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
ScanRequest.getFilterExpression()
public void setFilterExpression(java.lang.String filterExpression)
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
filterExpression
- Evaluates the query results and returns only the desired
values.
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
ScanRequest.setFilterExpression(String)
public DynamoDBScanExpression withFilterExpression(java.lang.String filterExpression)
The condition you specify is applied to the items queried; 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
- Evaluates the query results and returns only the desired
values.
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
ScanRequest.withFilterExpression(String)
public java.util.Map<java.lang.String,java.lang.String> getExpressionAttributeNames()
scanRequest#getExpressionAttributeNames()
public void setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
expressionAttributeNames
- One or more substitution variables for simplifying complex
expressions.ScanRequest.setExpressionAttributeNames(Map)
public DynamoDBScanExpression withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
expressionAttributeNames
- One or more substitution variables for simplifying complex
expressions.ScanRequest.withExpressionAttributeNames(Map)
public DynamoDBScanExpression addExpressionAttributeNamesEntry(java.lang.String key, java.lang.String value)
key
- The key of the entry to be added into
ExpressionAttributeNames.value
- The corresponding value of the entry to be added into
ExpressionAttributeNames.ScanRequest.addExpressionAttributeNamesEntry(String, String)
public DynamoDBScanExpression clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.String,AttributeValue> getExpressionAttributeValues()
ScanRequest.getExpressionAttributeValues()
public void setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
expressionAttributeValues
- One or more values that can be substituted in an expression.ScanRequest.setExpressionAttributeValues(Map)
public DynamoDBScanExpression withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
expressionAttributeValues
- One or more values that can be substituted in an expression.ScanRequest.withExpressionAttributeValues(Map)
public DynamoDBScanExpression addExpressionAttributeValuesEntry(java.lang.String key, AttributeValue value)
key
- The key of the entry to be added into
ExpressionAttributeValues.value
- The corresponding value of the entry to be added into
ExpressionAttributeValues.ScanRequest.addExpressionAttributeValuesEntry(String,
AttributeValue)
public DynamoDBScanExpression clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String getSelect()
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
Select
public void setSelect(java.lang.String 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, the count of matching items, or
in the case of an index, some or all of the attributes projected into
the index.Select
public DynamoDBScanExpression withSelect(java.lang.String 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, the count of matching items, or
in the case of an index, some or all of the attributes projected into
the index.Select
public void setSelect(Select 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, the count of matching items, or
in the case of an index, some or all of the attributes projected into
the index.Select
public DynamoDBScanExpression withSelect(Select 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, the count of matching items, or
in the case of an index, some or all of the attributes projected into
the index.Select
public java.lang.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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setProjectionExpression(java.lang.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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
projectionExpression
- A string that identifies 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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public DynamoDBScanExpression withProjectionExpression(java.lang.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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
projectionExpression
- A string that identifies 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.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public java.lang.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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
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(java.lang.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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
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 DynamoDBScanExpression withReturnConsumedCapacity(java.lang.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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
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 DynamoDBScanExpression 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
If enabled, the underlying request to DynamoDB will include the
configured parameter value and the low-level response from DynamoDB will
include the amount of capacity consumed by the scan. Currently, the
consumed capacity is only exposed through the DynamoDBMapper when you
call DynamoDBMapper.scanPage
, not DynamoDBMapper.scan
.
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 java.lang.Boolean isConsistentRead()
ScanRequest.isConsistentRead()
public void setConsistentRead(java.lang.Boolean consistentRead)
public DynamoDBScanExpression withConsistentRead(java.lang.Boolean consistentRead)