Class QuerySpec
java.lang.Object
com.amazonaws.services.dynamodbv2.document.spec.QuerySpec
Full parameter specification for the Query API.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe 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.boolean
boolean
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) viaQueryExpressionSpec
.withFilterExpression
(String filterExpression) When a filter expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
.withHashKey
(KeyAttribute hashKey) withHashKey
(String hashKeyName, Object hashKeyValue) withKeyConditionExpression
(String keyConditionExpression) When a key condition expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
.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) When a projection expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
.withQueryFilters
(QueryFilter... queryFilters) withRangeKeyCondition
(RangeKeyCondition rangeKeyCondition) withRequestMetricCollector
(RequestMetricCollector requestMetricCollector) withReturnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) withScanIndexForward
(boolean scanIndexForward) withSelect
(Select select) withValueMap
(Map<String, Object> valueMap) Applicable only when an expression has been specified.
-
Constructor Details
-
QuerySpec
public QuerySpec()
-
-
Method Details
-
getHashKey
-
withHashKey
-
withHashKey
-
getRangeKeyCondition
-
withRangeKeyCondition
-
withKeyConditionExpression
When a key condition expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
. (Note the hash key and range key conditions must not be specified if a key condition expression has been specified.) -
getKeyConditionExpression
-
withAttributesToGet
-
getAttributesToGet
-
withConditionalOperator
-
getConditionalOperator
-
withConsistentRead
-
isConsistentRead
public boolean isConsistentRead() -
withQueryFilters
-
getQueryFilters
-
withFilterExpression
When a filter expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
. (Note query filters must not be specified if a filter expression has been specified.) -
getFilterExpression
-
withProjectionExpression
When a projection expression is specified, the corresponding name-map and value-map can optionally be specified viawithNameMap(Map)
andwithValueMap(Map)
. (Note attributes-to-get must not be specified if a projection expression has been specified.) -
getProjectionExpression
-
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
-
withReturnConsumedCapacity
-
withScanIndexForward
-
isScanIndexForward
public boolean isScanIndexForward() -
withSelect
-
getSelect
-
getExclusiveStartKey
-
withExclusiveStartKey
-
withExclusiveStartKey
-
withExclusiveStartKey
-
withExclusiveStartKey
-
withMaxResultSize
-
withMaxResultSize
-
withMaxPageSize
-
withMaxPageSize
-
withProgressListener
-
withRequestMetricCollector
-
withExpressionSpec
Convenient method to specify expressions (and the associated name map and value map) viaQueryExpressionSpec
. -
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
-