com.amazonaws.mobileconnectors.dynamodbv2.document

Class ScanOperationConfig

java.lang.Object

com.amazonaws.mobileconnectors.dynamodbv2.document.ScanOperationConfig

public class ScanOperationConfig
extends java.lang.Object

Configuration for the Table.Scan operation

Constructor Summary

Constructors

Constructor and Description
ScanOperationConfig()

Method Summary

Modifier and Type	Method and Description
ScanOperationConfig	withAttributesToGet(java.util.List<java.lang.String> attributesToGet) Set attributes to get.
ScanOperationConfig	withCollectResults(boolean collectResults) Whether to collect GetNextSet and GetRemaining results in Matches property.
ScanOperationConfig	withConditionalOperator(ConditionalOperator conditionalOperator) A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true.
ScanOperationConfig	withConsistentRead(boolean consistentRead) Set Consistent Read.
ScanOperationConfig	withFilter(ScanFilter filter) Set Query Filter.
ScanOperationConfig	withFilterExpression(Expression filterExpression) Set filter expression.
ScanOperationConfig	withIndexName(java.lang.String indexName) Name of the index to query.
ScanOperationConfig	withLimit(int limit) The pagination size.
ScanOperationConfig	withSegment(int segment) For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process).
ScanOperationConfig	withSelect(Select select) Attributes to select.
ScanOperationConfig	withTotalSegments(int totalSegments) For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanOperationConfig

public ScanOperationConfig()

Method Detail

withConsistentRead

public ScanOperationConfig withConsistentRead(boolean consistentRead)

Set Consistent Read.

Parameters:

consistentRead - flag indicating if reads are consistent.

Returns:

current instance of ScanOperationConfig.

withAttributesToGet

public ScanOperationConfig withAttributesToGet(java.util.List<java.lang.String> attributesToGet)

Set attributes to get.

Parameters:

attributesToGet - the list of attributes to get.

Returns:

current instance of ScanOperationConfig.

withLimit

public ScanOperationConfig withLimit(int limit)

The pagination size.

Parameters:

limit - the pagination limit.

Returns:

current instance of ScanOperationConfig.

withFilterExpression

public ScanOperationConfig withFilterExpression(Expression filterExpression)

Set filter expression.

Parameters:

filterExpression - the filter expression. see Expression.

Returns:

current instance of ScanOperationConfig.

withFilter

public ScanOperationConfig withFilter(ScanFilter filter)

Set Query Filter.

Parameters:

filter - the QueryFilter expression. see QueryFilter.

Returns:

current instance of ScanOperationConfig.

withIndexName

public ScanOperationConfig withIndexName(java.lang.String indexName)

Name of the index to query.

Parameters:

indexName - the index name.

Returns:

current instance of ScanOperationConfig.

withSelect

public ScanOperationConfig withSelect(Select select)

Attributes to select.

Parameters:

select - Select.

Returns:

current instance of ScanOperationConfig.

withTotalSegments

public ScanOperationConfig withTotalSegments(int totalSegments)

For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the Scan request. The value of TotalSegments corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel Scan. For example, if you want to scan a table using four application threads, you would specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.

Parameters:

totalSegments - value in range 1-4096

Returns:

current instance of ScanOperationConfig.

withSegment

public ScanOperationConfig withSegment(int segment)

For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a Scan request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for Segment must be less than or equal to 0, and less than the value provided for TotalSegments. If you specify Segment, you must also specify TotalSegments.

Parameters:

segment - values in range 0-4095.

Returns:

current instance of ScanOperationConfig.

withCollectResults

public ScanOperationConfig withCollectResults(boolean collectResults)

Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.

Parameters:

collectResults - Whether to collect GetNextSet and GetRemaining results in Matches property

Returns:

current instance of ScanOperationConfig.

withConditionalOperator

public ScanOperationConfig withConditionalOperator(ConditionalOperator conditionalOperator)

A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND.

Parameters:

conditionalOperator - the Conditional operator. see ConditionalOperator.

Returns:

current instance of ScanOperationConfig.