@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ScanRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a Scan operation.
NOOP| Constructor and Description |
|---|
ScanRequest()
Default constructor for ScanRequest object.
|
ScanRequest(String tableName)
Constructs a new ScanRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
ScanRequest |
addExclusiveStartKeyEntry(String key,
AttributeValue value) |
ScanRequest |
addExpressionAttributeNamesEntry(String key,
String value) |
ScanRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value) |
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.
|
ScanRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
This is a legacy parameter.
|
String |
getConditionalOperator()
This is a legacy parameter.
|
Boolean |
getConsistentRead()
A Boolean value that determines the read consistency model during the scan:
|
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 attribute names in an expression.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
String |
getFilterExpression()
A string that contains conditions that DynamoDB applies after the
Scan operation, but before the
data is returned to you. |
String |
getIndexName()
The name of a secondary index to scan.
|
Integer |
getLimit()
The maximum number of items to evaluate (not necessarily the number of matching items).
|
String |
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the specified table or index.
|
String |
getReturnConsumedCapacity() |
Map<String,Condition> |
getScanFilter()
This is a legacy parameter.
|
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; or, if you provide
IndexName, the name of the
table to which that index belongs. |
Integer |
getTotalSegments()
For a parallel
Scan request, TotalSegments represents the total number of segments into
which the Scan operation will be divided. |
int |
hashCode() |
Boolean |
isConsistentRead()
A Boolean value that determines the read consistency model during the scan:
|
void |
setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter.
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
void |
setConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
void |
setConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
|
void |
setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys 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 attribute names in an expression.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the
Scan operation, but before the
data is returned to you. |
void |
setIndexName(String indexName)
The name of a secondary index to scan.
|
void |
setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).
|
void |
setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index.
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
void |
setReturnConsumedCapacity(String returnConsumedCapacity) |
void |
setScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter.
|
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; or, if you provide
IndexName, the name of the
table to which that index belongs. |
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)
This is a legacy parameter.
|
ScanRequest |
withAttributesToGet(String... attributesToGet)
This is a legacy parameter.
|
ScanRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
ScanRequest |
withConditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
ScanRequest |
withConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
|
ScanRequest |
withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys 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 attribute names in an expression.
|
ScanRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
ScanRequest |
withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the
Scan operation, but before the
data is returned to you. |
ScanRequest |
withIndexName(String indexName)
The name of a secondary index to scan.
|
ScanRequest |
withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).
|
ScanRequest |
withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index.
|
ScanRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
ScanRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
ScanRequest |
withScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter.
|
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; or, if you provide
IndexName, the name of the
table to which that index belongs. |
ScanRequest |
withTotalSegments(Integer totalSegments)
For a parallel
Scan request, TotalSegments represents the total number of segments into
which the Scan operation will be divided. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic ScanRequest()
public ScanRequest(String tableName)
tableName - The name of the table containing the requested items; or, if you provide IndexName, the name
of the table to which that index belongs.public void setTableName(String tableName)
The name of the table containing the requested items; or, if you provide IndexName, the name of the
table to which that index belongs.
tableName - The name of the table containing the requested items; or, if you provide IndexName, the name
of the table to which that index belongs.public String getTableName()
The name of the table containing the requested items; or, if you provide IndexName, the name of the
table to which that index belongs.
IndexName, the name
of the table to which that index belongs.public ScanRequest withTableName(String tableName)
The name of the table containing the requested items; or, if you provide IndexName, the name of the
table to which that index belongs.
tableName - The name of the table containing the requested items; or, if you provide IndexName, the name
of the table to which that index belongs.public void setIndexName(String indexName)
The name of a secondary index to scan. This index can be any local secondary index or global secondary index.
Note that if you use the IndexName parameter, you must also provide TableName.
indexName - The name of a secondary index to scan. This index can be any local secondary index or global secondary
index. Note that if you use the IndexName parameter, you must also provide
TableName.public String getIndexName()
The name of a secondary index to scan. This index can be any local secondary index or global secondary index.
Note that if you use the IndexName parameter, you must also provide TableName.
IndexName parameter, you must also provide
TableName.public ScanRequest withIndexName(String indexName)
The name of a secondary index to scan. This index can be any local secondary index or global secondary index.
Note that if you use the IndexName parameter, you must also provide TableName.
indexName - The name of a secondary index to scan. This index can be any local secondary index or global secondary
index. Note that if you use the IndexName parameter, you must also provide
TableName.public List<String> getAttributesToGet()
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.public void setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
attributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.public ScanRequest withAttributesToGet(String... attributesToGet)
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setAttributesToGet(java.util.Collection) or withAttributesToGet(java.util.Collection) if you
want to override the existing values.
attributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.public ScanRequest withAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
attributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.public void setLimit(Integer 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.
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 Integer getLimit()
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.
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)
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.
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 void setSelect(String 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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can
only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Selectpublic String getSelect()
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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
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 or scan 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 or scan 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
.)
If you use the ProjectionExpression parameter, then the value for Select can
only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Selectpublic ScanRequest withSelect(String 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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can
only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Selectpublic void setSelect(Select 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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can
only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Selectpublic ScanRequest withSelect(Select 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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
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.
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 or scan 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 or scan 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.)
If you use the ProjectionExpression parameter, then the value for Select can
only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
Selectpublic Map<String,Condition> getScanFilter()
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.public void setScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
scanFilter - This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.public ScanRequest withScanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
scanFilter - This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.public ScanRequest addScanFilterEntry(String key, Condition value)
public ScanRequest clearScanFilterEntries()
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic String getConditionalOperator()
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic ScanRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic ScanRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator - This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperatorpublic Map<String,AttributeValue> getExclusiveStartKey()
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.
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<String,AttributeValue> 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.
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 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.
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 addExclusiveStartKeyEntry(String key, AttributeValue value)
public ScanRequest clearExclusiveStartKeyEntries()
public void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic String getReturnConsumedCapacity()
ReturnConsumedCapacitypublic ScanRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic ScanRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - ReturnConsumedCapacitypublic void setTotalSegments(Integer 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 use four
application threads to scan a table or an index, 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.
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 use four application threads to scan a table or an index, 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 getTotalSegments()
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 use four
application threads to scan a table or an index, 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.
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 use four application threads to scan a table or an index,
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)
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 use four
application threads to scan a table or an index, 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.
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 use four application threads to scan a table or an index, 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 void setSegment(Integer 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 use four application
threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
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 use four
application threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
public Integer getSegment()
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 use four application
threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
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 use four
application threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
public ScanRequest withSegment(Integer 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 use four application
threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
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 use four
application threads to scan a table or an index, then 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 provide Segment, you must also provide TotalSegments.
public void setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index. 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
projectionExpression - A string that identifies one or more attributes to retrieve from the specified table or index. 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public String getProjectionExpression()
A string that identifies one or more attributes to retrieve from the specified table or index. 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public ScanRequest withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index. 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
projectionExpression - A string that identifies one or more attributes to retrieve from the specified table or index. 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does
not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
filterExpression - A string that contains conditions that DynamoDB applies after the Scan operation, but before
the data is returned to you. Items that do not satisfy the FilterExpression criteria are not
returned.
A FilterExpression is applied after the items have already been read; the process of
filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
public String getFilterExpression()
A string that contains conditions that DynamoDB applies after the Scan operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does
not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
Scan operation, but before
the data is returned to you. Items that do not satisfy the FilterExpression criteria are not
returned.
A FilterExpression is applied after the items have already been read; the process of
filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
public ScanRequest withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Scan operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does
not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
filterExpression - A string that contains conditions that DynamoDB applies after the Scan operation, but before
the data is returned to you. Items that do not satisfy the FilterExpression criteria are not
returned.
A FilterExpression is applied after the items have already been read; the process of
filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
expression. (For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public ScanRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
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 attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression.
(For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public ScanRequest addExpressionAttributeNamesEntry(String key, String value)
public ScanRequest clearExpressionAttributeNamesEntries()
public Map<String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public ScanRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues - One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public ScanRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public ScanRequest clearExpressionAttributeValuesEntries()
public void setConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might not
contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the
Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
secondary index with ConsistentRead set to true, you will receive a ValidationException
.
consistentRead - A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might
not contain the results from other recently completed write operations (PutItem, UpdateItem or
DeleteItem).
If ConsistentRead is true, then all of the write operations that completed
before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a
global secondary index with ConsistentRead set to true, you will receive a
ValidationException.
public Boolean getConsistentRead()
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might not
contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the
Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
secondary index with ConsistentRead set to true, you will receive a ValidationException
.
If ConsistentRead is false, then the data returned from Scan might
not contain the results from other recently completed write operations (PutItem, UpdateItem or
DeleteItem).
If ConsistentRead is true, then all of the write operations that completed
before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a
global secondary index with ConsistentRead set to true, you will receive a
ValidationException.
public ScanRequest withConsistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might not
contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the
Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
secondary index with ConsistentRead set to true, you will receive a ValidationException
.
consistentRead - A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might
not contain the results from other recently completed write operations (PutItem, UpdateItem or
DeleteItem).
If ConsistentRead is true, then all of the write operations that completed
before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a
global secondary index with ConsistentRead set to true, you will receive a
ValidationException.
public Boolean isConsistentRead()
A Boolean value that determines the read consistency model during the scan:
If ConsistentRead is false, then the data returned from Scan might not
contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the
Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
secondary index with ConsistentRead set to true, you will receive a ValidationException
.
If ConsistentRead is false, then the data returned from Scan might
not contain the results from other recently completed write operations (PutItem, UpdateItem or
DeleteItem).
If ConsistentRead is true, then all of the write operations that completed
before the Scan began are guaranteed to be contained in the Scan response.
The default setting for ConsistentRead is false.
The ConsistentRead parameter is not supported on global secondary indexes. If you scan a
global secondary index with ConsistentRead set to true, you will receive a
ValidationException.
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.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentExceptionpublic 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.
Returns a reference to this object so that method calls can be chained together.
hashKey - a map entry including the name and value of the primary hash key.rangeKey - a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentExceptionpublic String toString()
toString in class ObjectObject.toString()public ScanRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.