public static interface ScanRequest.Builder extends DynamoDbRequest.Builder, CopyableBuilder<ScanRequest.Builder,ScanRequest>
| Modifier and Type | Method and Description |
|---|---|
ScanRequest.Builder |
attributesToGet(Collection<String> attributesToGet)
This is a legacy parameter.
|
ScanRequest.Builder |
attributesToGet(String... attributesToGet)
This is a legacy parameter.
|
ScanRequest.Builder |
conditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter.
|
ScanRequest.Builder |
conditionalOperator(String conditionalOperator)
This is a legacy parameter.
|
ScanRequest.Builder |
consistentRead(Boolean consistentRead)
A Boolean value that determines the read consistency model during the scan:
|
ScanRequest.Builder |
exclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
ScanRequest.Builder |
expressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
ScanRequest.Builder |
expressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
ScanRequest.Builder |
filterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the
Scan operation, but before the
data is returned to you. |
ScanRequest.Builder |
indexName(String indexName)
The name of a secondary index to scan.
|
ScanRequest.Builder |
limit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).
|
ScanRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ScanRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ScanRequest.Builder |
projectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the specified table or index.
|
ScanRequest.Builder |
returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Sets the value of the ReturnConsumedCapacity property for this object.
|
ScanRequest.Builder |
returnConsumedCapacity(String returnConsumedCapacity)
Sets the value of the ReturnConsumedCapacity property for this object.
|
ScanRequest.Builder |
scanFilter(Map<String,Condition> scanFilter)
This is a legacy parameter.
|
ScanRequest.Builder |
segment(Integer segment)
For a parallel
Scan request, Segment identifies an individual segment to be scanned
by an application worker. |
ScanRequest.Builder |
select(Select select)
The attributes to be returned in the result.
|
ScanRequest.Builder |
select(String select)
The attributes to be returned in the result.
|
ScanRequest.Builder |
tableName(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.Builder |
totalSegments(Integer totalSegments)
For a parallel
Scan request, TotalSegments represents the total number of segments
into which the Scan operation will be divided. |
buildoverrideConfigurationcopyapplyMutation, buildScanRequest.Builder tableName(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.ScanRequest.Builder indexName(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.ScanRequest.Builder attributesToGet(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.ScanRequest.Builder attributesToGet(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.ScanRequest.Builder limit(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.ScanRequest.Builder select(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.
Select,
SelectScanRequest.Builder select(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.
Select,
SelectScanRequest.Builder scanFilter(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.ScanRequest.Builder conditionalOperator(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.ConditionalOperator,
ConditionalOperatorScanRequest.Builder conditionalOperator(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.ConditionalOperator,
ConditionalOperatorScanRequest.Builder exclusiveStartKey(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.
ScanRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.ReturnConsumedCapacity,
ReturnConsumedCapacityScanRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.ReturnConsumedCapacity,
ReturnConsumedCapacityScanRequest.Builder totalSegments(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.
ScanRequest.Builder segment(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.
ScanRequest.Builder projectionExpression(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.
ScanRequest.Builder filterExpression(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.
ScanRequest.Builder expressionAttributeNames(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.
ScanRequest.Builder expressionAttributeValues(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.
ScanRequest.Builder consistentRead(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.
ScanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.ScanRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.