com.amazonaws.mobileconnectors.dynamodbv2.document

Class QueryOperationConfig

java.lang.Object

com.amazonaws.mobileconnectors.dynamodbv2.document.QueryOperationConfig

public class QueryOperationConfig
extends java.lang.Object

Configuration for the Table.Query operation

Constructor Summary

Constructors

Constructor and Description
QueryOperationConfig()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	getAttributesToGet()
protected com.amazonaws.services.dynamodbv2.model.ConditionalOperator	getConditionalOperator()
protected QueryFilter	getFilter()
protected Expression	getFilterExpression()
protected java.lang.String	getIndexName()
protected Expression	getKeyExpression()
protected int	getLimit()
protected com.amazonaws.services.dynamodbv2.model.Select	getSelect()
protected boolean	isBackwardSearch()
protected boolean	isCollectResults()
protected boolean	isConsistentRead()
QueryOperationConfig	withAttributesToGet(java.util.List<java.lang.String> attributesToGet) Set attributes to get.
QueryOperationConfig	withBackwardSearch(boolean backwardSearch) param to search the query in descending order.
QueryOperationConfig	withCollectResults(boolean collectResults) Whether to collect GetNextSet and GetRemaining results in Matches property.
QueryOperationConfig	withConditionalOperator(com.amazonaws.services.dynamodbv2.model.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.
QueryOperationConfig	withConsistentRead(boolean consistentRead) Set Consistent Read.
QueryOperationConfig	withFilter(QueryFilter filter) Set Query Filter.
QueryOperationConfig	withFilterExpression(Expression filterExpression) Set filter expression.
QueryOperationConfig	withIndexName(java.lang.String indexName) Name of the index to query.
QueryOperationConfig	withKeyExpression(Expression keyExpression) Set key expression.
QueryOperationConfig	withLimit(int limit) The pagination size.
QueryOperationConfig	withSelect(com.amazonaws.services.dynamodbv2.model.Select select) Attributes to select.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOperationConfig

public QueryOperationConfig()

Method Detail

withKeyExpression

public QueryOperationConfig withKeyExpression(Expression keyExpression)

Set key expression.

Parameters:

keyExpression - the key expression. see Expression.

Returns:

current instance of QueryOperationConfig.

withFilterExpression

public QueryOperationConfig withFilterExpression(Expression filterExpression)

Set filter expression.

Parameters:

filterExpression - the filter expression. see Expression.

Returns:

current instance of QueryOperationConfig.

withFilter

public QueryOperationConfig withFilter(QueryFilter filter)

Set Query Filter.

Parameters:

filter - the QueryFilter expression. see QueryFilter.

Returns:

current instance of QueryOperationConfig.

withConsistentRead

public QueryOperationConfig withConsistentRead(boolean consistentRead)

Set Consistent Read.

Parameters:

consistentRead - flag indicating if reads are consistent. see consistentRead.

Returns:

current instance of QueryOperationConfig.

withAttributesToGet

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

Set attributes to get.

Parameters:

attributesToGet - the list of attributes to get.

Returns:

current instance of QueryOperationConfig.

withLimit

public QueryOperationConfig withLimit(int limit)

The pagination size.

Parameters:

limit - the pagination limit.

Returns:

current instance of QueryOperationConfig.

withBackwardSearch

public QueryOperationConfig withBackwardSearch(boolean backwardSearch)

param to search the query in descending order.

Parameters:

backwardSearch - flag to set descending order.

Returns:

current instance of QueryOperationConfig.

withIndexName

public QueryOperationConfig withIndexName(java.lang.String indexName)

Name of the index to query.

Parameters:

indexName - the index name.

Returns:

current instance of QueryOperationConfig.

withSelect

public QueryOperationConfig withSelect(com.amazonaws.services.dynamodbv2.model.Select select)

Attributes to select.

Parameters:

select - Select.

Returns:

current instance of QueryOperationConfig.

withCollectResults

public QueryOperationConfig 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 QueryOperationConfig.

withConditionalOperator

public QueryOperationConfig withConditionalOperator(com.amazonaws.services.dynamodbv2.model.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 QueryOperationConfig.

getKeyExpression

protected Expression getKeyExpression()

getFilterExpression

protected Expression getFilterExpression()

getFilter

protected QueryFilter getFilter()

isConsistentRead

protected boolean isConsistentRead()

getAttributesToGet

protected java.util.List<java.lang.String> getAttributesToGet()

getLimit

protected int getLimit()

isBackwardSearch

protected boolean isBackwardSearch()

getIndexName

protected java.lang.String getIndexName()

getSelect

protected com.amazonaws.services.dynamodbv2.model.Select getSelect()

isCollectResults

protected boolean isCollectResults()

getConditionalOperator

protected com.amazonaws.services.dynamodbv2.model.ConditionalOperator getConditionalOperator()