com.amazonaws.services.dynamodbv2.document.spec

Class ScanSpec

java.lang.Object

com.amazonaws.services.dynamodbv2.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 and Description
ScanSpec()

Method Summary

Methods

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.
Integer	getMaxPageSize() The maximum number of resources to be retrieved in a single page; used for pagination purposes.
Integer	getMaxResultSize() The maximum number of resources to be retrieved in this query, including all the resources in all pages to be retrieved.
Map<String,String>	getNameMap()
com.amazonaws.event.ProgressListener	getProgressListener()
String	getProjectionExpression()
T	getRequest() Internal method.
com.amazonaws.metrics.RequestMetricCollector	getRequestMetricCollector()
String	getReturnConsumedCapacity()
Collection<ScanFilter>	getScanFilters()
Integer	getSegment()
String	getSelect() Specifies the attributes to be returned.
Integer	getTotalSegments()
Map<String,Object>	getValueMap()
void	setMaxPageSize(Integer value)
void	setMaxResultSize(int maxResultSize)
void	setMaxResultSize(Integer maxResultSize)
void	setProgressListener(com.amazonaws.event.ProgressListener progressListener)
void	setRequestMetricCollector(com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
ScanSpec	withAttributesToGet(String... attributes)
ScanSpec	withConditionalOperator(ConditionalOperator op)
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 expression)
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(com.amazonaws.event.ProgressListener progressListener)
ScanSpec	withProjectionExpression(String expression)
ScanSpec	withRequestMetricCollector(com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
ScanSpec	withReturnConsumedCapacity(ReturnConsumedCapacity capacity)
ScanSpec	withScanFilters(ScanFilter... scanFilters)
ScanSpec	withSegment(Integer segment)
ScanSpec	withSelect(Select select)
ScanSpec	withTotalSegments(Integer totalSegments)
ScanSpec	withValueMap(Map<String,Object> valueMap) Applicable only when an expression has been specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanSpec

public ScanSpec()

Method Detail

getScanFilters

public Collection<ScanFilter> getScanFilters()

withScanFilters

public ScanSpec withScanFilters(ScanFilter... scanFilters)

getConditionalOperator

public String getConditionalOperator()

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

withConditionalOperator

public ScanSpec withConditionalOperator(ConditionalOperator op)

getAttributesToGet

public List<String> getAttributesToGet()

withAttributesToGet

public ScanSpec withAttributesToGet(String... attributes)

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 withValueMap(Map).

withFilterExpression

public ScanSpec withFilterExpression(String expression)

getProjectionExpression

public String getProjectionExpression()

withProjectionExpression

public ScanSpec withProjectionExpression(String expression)

getNameMap

public Map<String,String> getNameMap()

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.

getValueMap

public Map<String,Object> getValueMap()

withValueMap

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

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

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

withReturnConsumedCapacity

public ScanSpec withReturnConsumedCapacity(ReturnConsumedCapacity capacity)

getSelect

public String getSelect()

Specifies the attributes to be returned.

withSelect

public ScanSpec withSelect(Select select)

getSegment

public Integer getSegment()

withSegment

public ScanSpec withSegment(Integer segment)

getTotalSegments

public Integer getTotalSegments()

withTotalSegments

public ScanSpec withTotalSegments(Integer totalSegments)

getExclusiveStartKey

public Collection<KeyAttribute> getExclusiveStartKey()

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(KeyAttribute... exclusiveStartKey)

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(PrimaryKey exclusiveStartKey)

withExclusiveStartKey

public ScanSpec withExclusiveStartKey(String hashKeyName,
                             Object hashKeyValue)

withExclusiveStartKey

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

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(com.amazonaws.event.ProgressListener progressListener)

withRequestMetricCollector

public ScanSpec withRequestMetricCollector(com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

getMaxResultSize

public Integer getMaxResultSize()

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)

getMaxPageSize

public Integer getMaxPageSize()

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

setMaxPageSize

public void setMaxPageSize(Integer value)

getRequest

public T getRequest()

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

getProgressListener

public com.amazonaws.event.ProgressListener getProgressListener()

setProgressListener

public void setProgressListener(com.amazonaws.event.ProgressListener progressListener)

getRequestMetricCollector

public com.amazonaws.metrics.RequestMetricCollector getRequestMetricCollector()

setRequestMetricCollector

public void setRequestMetricCollector(com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)