public class ScanSpec extends AbstractCollectionSpec<ScanRequest>
Modifier and Type | Field and Description |
---|---|
private java.util.Collection<KeyAttribute> |
exclusiveStartKey |
private java.util.Map<java.lang.String,java.lang.String> |
nameMap |
private java.util.Collection<ScanFilter> |
scanFilters |
private java.util.Map<java.lang.String,java.lang.Object> |
valueMap |
Constructor and Description |
---|
ScanSpec() |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAttributesToGet() |
java.lang.String |
getConditionalOperator()
AND|OR that applies to all the conditions in the ScanFilters.
|
java.util.Collection<KeyAttribute> |
getExclusiveStartKey() |
java.lang.String |
getFilterExpression()
Any query filters will be ignored if a filter expression has been
specified.
|
java.util.Map<java.lang.String,java.lang.String> |
getNameMap() |
java.lang.String |
getProjectionExpression() |
java.lang.String |
getReturnConsumedCapacity() |
java.util.Collection<ScanFilter> |
getScanFilters() |
java.lang.Integer |
getSegment() |
java.lang.String |
getSelect()
Specifies the attributes to be returned.
|
java.lang.Integer |
getTotalSegments() |
java.util.Map<java.lang.String,java.lang.Object> |
getValueMap() |
java.lang.Boolean |
isConsistentRead() |
ScanSpec |
withAttributesToGet(java.lang.String... attributes) |
ScanSpec |
withConditionalOperator(ConditionalOperator op) |
ScanSpec |
withConsistentRead(java.lang.Boolean consistentRead) |
ScanSpec |
withExclusiveStartKey(KeyAttribute... exclusiveStartKey) |
ScanSpec |
withExclusiveStartKey(PrimaryKey exclusiveStartKey) |
ScanSpec |
withExclusiveStartKey(java.lang.String hashKeyName,
java.lang.Object hashKeyValue) |
ScanSpec |
withExclusiveStartKey(java.lang.String hashKeyName,
java.lang.Object hashKeyValue,
java.lang.String rangeKeyName,
java.lang.Object rangeKeyValue) |
ScanSpec |
withExpressionSpec(ScanExpressionSpec xspec)
Convenient method to specify expressions (and the associated name map and
value map) via
ScanExpressionSpec . |
ScanSpec |
withFilterExpression(java.lang.String filterExpression) |
ScanSpec |
withMaxPageSize(int maxPageSize) |
ScanSpec |
withMaxPageSize(java.lang.Integer maxPageSize) |
ScanSpec |
withMaxResultSize(int maxResultSize) |
ScanSpec |
withMaxResultSize(java.lang.Integer maxResultSize) |
ScanSpec |
withNameMap(java.util.Map<java.lang.String,java.lang.String> nameMap)
Applicable only when an expression has been specified.
|
ScanSpec |
withProgressListener(ProgressListener progressListener) |
ScanSpec |
withProjectionExpression(java.lang.String projectionExpression) |
ScanSpec |
withRequestMetricCollector(RequestMetricCollector requestMetricCollector) |
ScanSpec |
withReturnConsumedCapacity(ReturnConsumedCapacity capacity) |
ScanSpec |
withScanFilters(ScanFilter... scanFilters) |
ScanSpec |
withSegment(java.lang.Integer segment) |
ScanSpec |
withSelect(Select select) |
ScanSpec |
withTotalSegments(java.lang.Integer totalSegments) |
ScanSpec |
withValueMap(java.util.Map<java.lang.String,java.lang.Object> valueMap)
Applicable only when an expression has been specified.
|
getMaxPageSize, getMaxResultSize, setMaxPageSize, setMaxResultSize, setMaxResultSize
getProgressListener, getRequest, getRequestMetricCollector, setProgressListener, setRequestMetricCollector
private java.util.Collection<ScanFilter> scanFilters
private java.util.Map<java.lang.String,java.lang.String> nameMap
private java.util.Map<java.lang.String,java.lang.Object> valueMap
private java.util.Collection<KeyAttribute> exclusiveStartKey
public java.util.Collection<ScanFilter> getScanFilters()
ScanRequest.getScanFilter()
public ScanSpec withScanFilters(ScanFilter... scanFilters)
ScanRequest.withScanFilter(Map)
public java.lang.String getConditionalOperator()
ScanRequest.getConditionalOperator()
public ScanSpec withConditionalOperator(ConditionalOperator op)
public java.util.List<java.lang.String> getAttributesToGet()
ScanRequest.getAttributesToGet()
public ScanSpec withAttributesToGet(java.lang.String... attributes)
public java.lang.String getFilterExpression()
withNameMap(Map)
and withValueMap(Map)
.ScanRequest.getFilterExpression()
public ScanSpec withFilterExpression(java.lang.String filterExpression)
ScanRequest.withFilterExpression(String)
public java.lang.String getProjectionExpression()
ScanRequest.getProjectionExpression()
public ScanSpec withProjectionExpression(java.lang.String projectionExpression)
public java.util.Map<java.lang.String,java.lang.String> getNameMap()
public ScanSpec withNameMap(java.util.Map<java.lang.String,java.lang.String> nameMap)
public java.util.Map<java.lang.String,java.lang.Object> getValueMap()
public ScanSpec withValueMap(java.util.Map<java.lang.String,java.lang.Object> valueMap)
public java.lang.String getReturnConsumedCapacity()
ScanRequest.getReturnConsumedCapacity()
public ScanSpec withReturnConsumedCapacity(ReturnConsumedCapacity capacity)
public java.lang.String getSelect()
ScanRequest.getSelect()
public ScanSpec withSelect(Select select)
ScanRequest.withSelect(Select)
public java.lang.Integer getSegment()
ScanRequest.getSegment()
public ScanSpec withSegment(java.lang.Integer segment)
ScanRequest.withSegment(Integer)
public java.lang.Integer getTotalSegments()
ScanRequest.getTotalSegments()
public ScanSpec withTotalSegments(java.lang.Integer totalSegments)
ScanRequest.withTotalSegments(Integer)
public java.lang.Boolean isConsistentRead()
ScanRequest.isConsistentRead()
public ScanSpec withConsistentRead(java.lang.Boolean consistentRead)
ScanRequest.withConsistentRead(Boolean)
public java.util.Collection<KeyAttribute> getExclusiveStartKey()
ScanRequest.getExclusiveStartKey()
public ScanSpec withExclusiveStartKey(KeyAttribute... exclusiveStartKey)
ScanRequest.withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(PrimaryKey exclusiveStartKey)
ScanRequest.withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(java.lang.String hashKeyName, java.lang.Object hashKeyValue)
ScanRequest.withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(java.lang.String hashKeyName, java.lang.Object hashKeyValue, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue)
ScanRequest.withExclusiveStartKey(Map)
public ScanSpec withMaxResultSize(java.lang.Integer maxResultSize)
withMaxResultSize
in class AbstractCollectionSpec<ScanRequest>
public ScanSpec withMaxResultSize(int maxResultSize)
withMaxResultSize
in class AbstractCollectionSpec<ScanRequest>
public ScanSpec withMaxPageSize(java.lang.Integer maxPageSize)
withMaxPageSize
in class AbstractCollectionSpec<ScanRequest>
public ScanSpec withMaxPageSize(int maxPageSize)
withMaxPageSize
in class AbstractCollectionSpec<ScanRequest>
public ScanSpec withProgressListener(ProgressListener progressListener)
withProgressListener
in class AbstractSpec<ScanRequest>
public ScanSpec withRequestMetricCollector(RequestMetricCollector requestMetricCollector)
withRequestMetricCollector
in class AbstractSpec<ScanRequest>
@Beta public ScanSpec withExpressionSpec(ScanExpressionSpec xspec)
ScanExpressionSpec
.