public class ScanSpec extends Object
Constructor and Description |
---|
ScanSpec() |
Modifier and Type | Method and Description |
---|---|
List<String> |
getAttributesToGet() |
String |
getConditionalOperator()
AND|OR that applies to all the conditions in the ScanFilters.
|
Collection<KeyAttribute> |
getExclusiveStartKey() |
String |
getFilterExpression()
Any query filters will be ignored if a filter expression has been
specified.
|
software.amazon.awssdk.event.ProgressListener |
getProgressListener() |
String |
getProjectionExpression() |
T |
getRequest()
Internal method.
|
String |
getReturnConsumedCapacity() |
Integer |
getTotalSegments() |
Boolean |
isConsistentRead() |
Integer |
maxPageSize()
The maximum number of resources to be retrieved in a single page; used
for pagination purposes.
|
Integer |
maxResultSize()
The maximum number of resources to be retrieved in this query, including
all the resources in all pages to be retrieved.
|
Map<String,String> |
nameMap() |
Collection<ScanFilter> |
scanFilters() |
Integer |
segment() |
String |
select()
Specifies the attributes to be returned.
|
void |
setMaxPageSize(Integer value) |
void |
setMaxResultSize(int maxResultSize) |
void |
setMaxResultSize(Integer maxResultSize) |
void |
setProgressListener(software.amazon.awssdk.event.ProgressListener progressListener) |
void |
setRequest(T req) |
Map<String,Object> |
valueMap() |
ScanSpec |
valueMap(Map<String,Object> valueMap)
Applicable only when an expression has been specified.
|
ScanSpec |
withAttributesToGet(String... attributes) |
ScanSpec |
withConditionalOperator(ConditionalOperator op) |
ScanSpec |
withConsistentRead(Boolean consistentRead) |
ScanSpec |
withExclusiveStartKey(KeyAttribute... exclusiveStartKey) |
ScanSpec |
withExclusiveStartKey(PrimaryKey exclusiveStartKey) |
ScanSpec |
withExclusiveStartKey(String hashKeyName,
Object hashKeyValue) |
ScanSpec |
withExclusiveStartKey(String hashKeyName,
Object hashKeyValue,
String rangeKeyName,
Object rangeKeyValue) |
ScanSpec |
withFilterExpression(String filterExpression) |
ScanSpec |
withMaxPageSize(int maxPageSize) |
ScanSpec |
withMaxPageSize(Integer maxPageSize) |
ScanSpec |
withMaxResultSize(int maxResultSize) |
ScanSpec |
withMaxResultSize(Integer maxResultSize) |
ScanSpec |
withNameMap(Map<String,String> nameMap)
Applicable only when an expression has been specified.
|
ScanSpec |
withProgressListener(software.amazon.awssdk.event.ProgressListener progressListener) |
ScanSpec |
withProjectionExpression(String projectionExpression) |
ScanSpec |
withReturnConsumedCapacity(ReturnConsumedCapacity capacity) |
ScanSpec |
withScanFilters(ScanFilter... scanFilters) |
ScanSpec |
withSegment(Integer segment) |
ScanSpec |
withSelect(Select select) |
ScanSpec |
withTotalSegments(Integer totalSegments) |
public Collection<ScanFilter> scanFilters()
ScanRequest.scanFilter()
public ScanSpec withScanFilters(ScanFilter... scanFilters)
ScanRequest#withScanFilter(Map)
public String getConditionalOperator()
ScanRequest#getConditionalOperator()
public ScanSpec withConditionalOperator(ConditionalOperator op)
ScanRequest#withConditionalOperator(ConditionalOperator)
public List<String> getAttributesToGet()
ScanRequest#getAttributesToGet()
public ScanSpec withAttributesToGet(String... attributes)
ScanRequest#withAttributesToGet(String...)
public String getFilterExpression()
withNameMap(Map)
and valueMap(Map)
.ScanRequest#getFilterExpression()
public ScanSpec withFilterExpression(String filterExpression)
ScanRequest#withFilterExpression(String)
public String getProjectionExpression()
ScanRequest#getProjectionExpression()
public ScanSpec withProjectionExpression(String projectionExpression)
ScanRequest#withProjectionExpression(String)
public ScanSpec withNameMap(Map<String,String> nameMap)
ScanRequest#withExpressionAttributeNames(Map)
public ScanSpec valueMap(Map<String,Object> valueMap)
ScanRequest#withExpressionAttributeValues(Map)
public String getReturnConsumedCapacity()
ScanRequest#getReturnConsumedCapacity()
public ScanSpec withReturnConsumedCapacity(ReturnConsumedCapacity capacity)
ScanRequest#withReturnConsumedCapacity(ReturnConsumedCapacity)
public String select()
ScanRequest.select()
public Integer segment()
ScanRequest.segment()
public Integer getTotalSegments()
ScanRequest#getTotalSegments()
public ScanSpec withTotalSegments(Integer totalSegments)
ScanRequest#withTotalSegments(Integer)
public Boolean isConsistentRead()
ScanRequest#isConsistentRead()
public ScanSpec withConsistentRead(Boolean consistentRead)
ScanRequest#withConsistentRead(Boolean)
public Collection<KeyAttribute> getExclusiveStartKey()
ScanRequest#getExclusiveStartKey()
public ScanSpec withExclusiveStartKey(KeyAttribute... exclusiveStartKey)
ScanRequest#withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(PrimaryKey exclusiveStartKey)
ScanRequest#withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(String hashKeyName, Object hashKeyValue)
ScanRequest#withExclusiveStartKey(Map)
public ScanSpec withExclusiveStartKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
ScanRequest#withExclusiveStartKey(Map)
public ScanSpec withMaxResultSize(int maxResultSize)
public ScanSpec withMaxPageSize(int maxPageSize)
public ScanSpec withProgressListener(software.amazon.awssdk.event.ProgressListener progressListener)
public Integer maxResultSize()
public void setMaxResultSize(Integer maxResultSize)
public void setMaxResultSize(int maxResultSize)
public Integer maxPageSize()
public void setMaxPageSize(Integer value)
public void setRequest(T req)
public T getRequest()
public software.amazon.awssdk.event.ProgressListener getProgressListener()
public void setProgressListener(software.amazon.awssdk.event.ProgressListener progressListener)
Copyright © 2017. All rights reserved.