Package software.amazon.awssdk.services.dynamodb.document.spec

Class ScanSpec

java.lang.Object

software.amazon.awssdk.services.dynamodb.document.spec.ScanSpec

public class ScanSpec
extends Object

API for fully specifying all the parameters of a Table-centric Scan API.

Constructor Summary

Constructors

Constructor	Description
ScanSpec()

Method Summary

Modifier and Type	Method	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.
ProgressListener	getProgressListener()
String	getProjectionExpression()
T	getRequest()	Internal method.
RequestMetricCollector	getRequestMetricCollector()
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(ProgressListener progressListener)
void	setRequest(T req)
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector)
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(String hashKeyName, Object hashKeyValue)
ScanSpec	withExclusiveStartKey(String hashKeyName, Object hashKeyValue, String rangeKeyName, Object rangeKeyValue)
ScanSpec	withExclusiveStartKey(KeyAttribute... exclusiveStartKey)
ScanSpec	withExclusiveStartKey(PrimaryKey exclusiveStartKey)
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(ProgressListener progressListener)
ScanSpec	withProjectionExpression(String projectionExpression)
ScanSpec	withRequestMetricCollector(RequestMetricCollector requestMetricCollector)
ScanSpec	withReturnConsumedCapacity(ReturnConsumedCapacity capacity)
ScanSpec	withScanFilters(ScanFilter... scanFilters)
ScanSpec	withSegment(Integer segment)
ScanSpec	withSelect(Select select)
ScanSpec	withTotalSegments(Integer totalSegments)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScanSpec

public ScanSpec()

Method Detail

scanFilters

public Collection<ScanFilter> scanFilters()

See Also:

ScanRequest.scanFilter()

withScanFilters

public ScanSpec withScanFilters(ScanFilter... scanFilters)

See Also:

ScanRequest#withScanFilter(Map)

getConditionalOperator

public String getConditionalOperator()

AND|OR that applies to all the conditions in the ScanFilters.

See Also:

ScanRequest#getConditionalOperator()

withConditionalOperator

public ScanSpec withConditionalOperator(ConditionalOperator op)

See Also:

ScanRequest#withConditionalOperator(ConditionalOperator)

getAttributesToGet

public List<String> getAttributesToGet()

See Also:

ScanRequest#getAttributesToGet()

withAttributesToGet

public ScanSpec withAttributesToGet(String... attributes)

See Also:

ScanRequest#withAttributesToGet(String...)

getFilterExpression

public String 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 via withNameMap(Map) and valueMap(Map).

See Also:

ScanRequest#getFilterExpression()

withFilterExpression

public ScanSpec withFilterExpression(String filterExpression)

See Also:

ScanRequest#withFilterExpression(String)

getProjectionExpression

public String getProjectionExpression()

See Also:

ScanRequest#getProjectionExpression()

withProjectionExpression

public ScanSpec withProjectionExpression(String projectionExpression)

See Also:

ScanRequest#withProjectionExpression(String)

nameMap

public Map<String,String> nameMap()

See Also:

ScanRequest#getExpressionAttributeNames()

withNameMap

public ScanSpec withNameMap(Map<String,String> nameMap)

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.

See Also:

ScanRequest#withExpressionAttributeNames(Map)

valueMap

public Map<String,Object> valueMap()

See Also:

ScanRequest#getExpressionAttributeValues()

valueMap

public ScanSpec valueMap(Map<String,Object> valueMap)

Applicable only when an expression has been specified. Used to specify the actual values for the attribute-value placeholders.

See Also:

ScanRequest#withExpressionAttributeValues(Map)

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

See Also:

ScanRequest#getReturnConsumedCapacity()

withReturnConsumedCapacity

public ScanSpec withReturnConsumedCapacity(ReturnConsumedCapacity capacity)

See Also:

ScanRequest#withReturnConsumedCapacity(ReturnConsumedCapacity)

select

public String select()

Specifies the attributes to be returned.

See Also:

ScanRequest.select()

withSelect

public ScanSpec withSelect(Select select)

See Also:

ScanRequest#withSelect(Select)

segment

public Integer segment()

See Also:

ScanRequest.segment()

withSegment

public ScanSpec withSegment(Integer segment)

See Also:

ScanRequest#withSegment(Integer)

getTotalSegments

public Integer getTotalSegments()

See Also:

ScanRequest#getTotalSegments()

withTotalSegments

public ScanSpec withTotalSegments(Integer totalSegments)

See Also:

ScanRequest#withTotalSegments(Integer)

isConsistentRead

public Boolean isConsistentRead()

See Also:

ScanRequest#isConsistentRead()

withConsistentRead

public ScanSpec withConsistentRead(Boolean consistentRead)

See Also:

ScanRequest#withConsistentRead(Boolean)

getExclusiveStartKey

public Collection<KeyAttribute> getExclusiveStartKey()

See Also:

ScanRequest#getExclusiveStartKey()

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(KeyAttribute... exclusiveStartKey)

See Also:

ScanRequest#withExclusiveStartKey(Map)

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(PrimaryKey exclusiveStartKey)

See Also:

ScanRequest#withExclusiveStartKey(Map)

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(String hashKeyName,
                                      Object hashKeyValue)

See Also:

ScanRequest#withExclusiveStartKey(Map)

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(String hashKeyName,
                                      Object hashKeyValue,
                                      String rangeKeyName,
                                      Object rangeKeyValue)

See Also:

ScanRequest#withExclusiveStartKey(Map)

withMaxResultSize

public ScanSpec withMaxResultSize(Integer maxResultSize)

withMaxResultSize

public ScanSpec withMaxResultSize(int maxResultSize)

withMaxPageSize

public ScanSpec withMaxPageSize(Integer maxPageSize)

withMaxPageSize

public ScanSpec withMaxPageSize(int maxPageSize)

withProgressListener

public ScanSpec withProgressListener(ProgressListener progressListener)

withRequestMetricCollector

public ScanSpec withRequestMetricCollector(RequestMetricCollector requestMetricCollector)

maxResultSize

public Integer maxResultSize()

The maximum number of resources to be retrieved in this query, including all the resources in all pages to be retrieved.

setMaxResultSize

public void setMaxResultSize(Integer maxResultSize)

setMaxResultSize

public void setMaxResultSize(int maxResultSize)

maxPageSize

public Integer maxPageSize()

The maximum number of resources to be retrieved in a single page; used for pagination purposes.

setMaxPageSize

public void setMaxPageSize(Integer value)

setRequest

public void setRequest(T req)

getRequest

public T getRequest()

Internal method. Not meant to be called directly. May change without notice.

getProgressListener

public ProgressListener getProgressListener()

setProgressListener

public void setProgressListener(ProgressListener progressListener)

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)