Class ScanSpec
java.lang.Object
com.amazonaws.services.dynamodbv2.document.spec.ScanSpec
API for fully specifying all the parameters of a Table-centric Scan API.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAND|OR that applies to all the conditions in the ScanFilters.Any query filters will be ignored if a filter expression has been specified.The maximum number of resources to be retrieved in a single page; used for pagination purposes.The maximum number of resources to be retrieved in this query, including all the resources in all pages to be retrieved.Internal method.Specifies the attributes to be returned.void
setMaxPageSize
(Integer value) void
setMaxResultSize
(int maxResultSize) void
setMaxResultSize
(Integer maxResultSize) void
setProgressListener
(ProgressListener progressListener) void
setRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withAttributesToGet
(String... attributes) withConsistentRead
(Boolean consistentRead) withExclusiveStartKey
(KeyAttribute... exclusiveStartKey) withExclusiveStartKey
(PrimaryKey exclusiveStartKey) withExclusiveStartKey
(String hashKeyName, Object hashKeyValue) withExclusiveStartKey
(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) Convenient method to specify expressions (and the associated name map and value map) viaScanExpressionSpec
.withFilterExpression
(String filterExpression) withMaxPageSize
(int maxPageSize) withMaxPageSize
(Integer maxPageSize) withMaxResultSize
(int maxResultSize) withMaxResultSize
(Integer maxResultSize) withNameMap
(Map<String, String> nameMap) Applicable only when an expression has been specified.withProgressListener
(ProgressListener progressListener) withProjectionExpression
(String projectionExpression) withRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withScanFilters
(ScanFilter... scanFilters) withSegment
(Integer segment) withSelect
(Select select) withTotalSegments
(Integer totalSegments) withValueMap
(Map<String, Object> valueMap) Applicable only when an expression has been specified.
-
Constructor Details
-
ScanSpec
public ScanSpec()
-
-
Method Details
-
getScanFilters
- See Also:
-
withScanFilters
- See Also:
-
getConditionalOperator
AND|OR that applies to all the conditions in the ScanFilters.- See Also:
-
withConditionalOperator
-
getAttributesToGet
- See Also:
-
withAttributesToGet
-
getFilterExpression
Any query filters will be ignored if a filter expression has been specified. When a filter expression is specified, the corresponding name-map and value-map can also be specified viawithNameMap(Map)
andwithValueMap(Map)
.- See Also:
-
withFilterExpression
- See Also:
-
getProjectionExpression
- See Also:
-
withProjectionExpression
-
getNameMap
-
withNameMap
Applicable only when an expression has been specified. Used to specify the actual values for the attribute-name placeholders, where the value in the map can either be string for simple attribute name, or a JSON path expression. -
getValueMap
-
withValueMap
Applicable only when an expression has been specified. Used to specify the actual values for the attribute-value placeholders. -
getReturnConsumedCapacity
- See Also:
-
withReturnConsumedCapacity
-
getSelect
Specifies the attributes to be returned.- See Also:
-
withSelect
- See Also:
-
getSegment
- See Also:
-
withSegment
- See Also:
-
getTotalSegments
- See Also:
-
withTotalSegments
- See Also:
-
isConsistentRead
- See Also:
-
withConsistentRead
- See Also:
-
getExclusiveStartKey
- See Also:
-
withExclusiveStartKey
- See Also:
-
withExclusiveStartKey
- See Also:
-
withExclusiveStartKey
- See Also:
-
withExclusiveStartKey
public ScanSpec withExclusiveStartKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue) - See Also:
-
withMaxResultSize
-
withMaxResultSize
-
withMaxPageSize
-
withMaxPageSize
-
withProgressListener
-
withRequestMetricCollector
-
withExpressionSpec
Convenient method to specify expressions (and the associated name map and value map) viaScanExpressionSpec
. -
getMaxResultSize
The maximum number of resources to be retrieved in this query, including all the resources in all pages to be retrieved. -
setMaxResultSize
-
setMaxResultSize
public void setMaxResultSize(int maxResultSize) -
getMaxPageSize
The maximum number of resources to be retrieved in a single page; used for pagination purposes. -
setMaxPageSize
-
getRequest
Internal method. Not meant to be called directly. May change without notice. -
getProgressListener
-
setProgressListener
-
getRequestMetricCollector
-
setRequestMetricCollector
-