com.basho.riak.client.core.operations

Class SecondaryIndexQueryOperation.Query.Builder

java.lang.Object

com.basho.riak.client.core.operations.SecondaryIndexQueryOperation.Query.Builder

Enclosing class:

SecondaryIndexQueryOperation.Query

public static class SecondaryIndexQueryOperation.Query.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(Namespace namespace, BinaryValue indexName) Constructs a builder for a (2i) Query.

Method Summary

Modifier and Type	Method and Description
SecondaryIndexQueryOperation.Query	build()
SecondaryIndexQueryOperation.Query.Builder	withContinuation(BinaryValue continuation) Set the continuation for this query.
SecondaryIndexQueryOperation.Query.Builder	withCoverageContext(byte[] coverageContext) Set the coverage context for the query
SecondaryIndexQueryOperation.Query.Builder	withIndexKey(BinaryValue key) Set a single secondary index key to use for query.
SecondaryIndexQueryOperation.Query.Builder	withMaxResults(int maxResults) Set the maximum number of results returned by the query.
SecondaryIndexQueryOperation.Query.Builder	withPaginationSort(boolean orderByKey) Set whether to sort the results of a non-paginated 2i query.
SecondaryIndexQueryOperation.Query.Builder	withRangeEnd(BinaryValue endIndex) Set the ending value for a range query.
SecondaryIndexQueryOperation.Query.Builder	withRangeStart(BinaryValue startingIndex) Set the start value for a range query.
SecondaryIndexQueryOperation.Query.Builder	withRegexTermFilter(BinaryValue filter) Set the regex to filter result terms by for this query.
SecondaryIndexQueryOperation.Query.Builder	withReturnBody(boolean returnBody) Set whether to return list of RiakObjects inside the response.
SecondaryIndexQueryOperation.Query.Builder	withReturnKeyAndIndex(boolean returnBoth) Set whether to return the index keys with the Riak object keys.
SecondaryIndexQueryOperation.Query.Builder	withTimeout(int timeout) Set the timeout for the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Namespace namespace,
               BinaryValue indexName)

Constructs a builder for a (2i) Query. The index name must be the complete name with the _int or _bin suffix.

Parameters:

namespace - the namespace for this Query

indexName - the name of the index (including suffix).

Method Detail

withIndexKey

public SecondaryIndexQueryOperation.Query.Builder withIndexKey(BinaryValue key)

Set a single secondary index key to use for query. If querying a _int index the bytes must be the UTF-8 text representation of an integer (Yes, really).

Parameters:

key - the secondary index key.

Returns:

a reference to this object.

withRangeStart

public SecondaryIndexQueryOperation.Query.Builder withRangeStart(BinaryValue startingIndex)

Set the start value for a range query. If querying a _int index the bytes must be the UTF-8 text representation of an integer (Yes, really).

Parameters:

startingIndex - the starting index for a range query.

Returns:

a reference to this object.

withRangeEnd

public SecondaryIndexQueryOperation.Query.Builder withRangeEnd(BinaryValue endIndex)

Set the ending value for a range query. If querying a _int index the bytes must be the UTF-8 text representation of an integer (Yes, really).

Parameters:

endIndex - the ending index for a range query.

Returns:

a reference to this object.

withReturnKeyAndIndex

public SecondaryIndexQueryOperation.Query.Builder withReturnKeyAndIndex(boolean returnBoth)

Set whether to return the index keys with the Riak object keys. Setting this to true will return both the index key and the Riak object's key. The default is false (only to return the Riak object keys).

Parameters:

returnBoth - true to return both index and object keys, false to return only object keys.

Returns:

a reference to this object.

withMaxResults

public SecondaryIndexQueryOperation.Query.Builder withMaxResults(int maxResults)

Set the maximum number of results returned by the query.

Parameters:

maxResults - the number of results.

Returns:

a reference to this object.

withContinuation

public SecondaryIndexQueryOperation.Query.Builder withContinuation(BinaryValue continuation)

Set the continuation for this query.

Parameters:

continuation - the continuation.

Returns:

a reference to this object.

withPaginationSort

public SecondaryIndexQueryOperation.Query.Builder withPaginationSort(boolean orderByKey)

Set whether to sort the results of a non-paginated 2i query.

Setting this to true will sort the results in Riak before returning them.

Note that this is not recommended for queries that could return a large result set; the overhead in Riak is substantial.

Parameters:

orderByKey - true to sort the results, false to return as-is.

Returns:

a reference to this object.

withRegexTermFilter

public SecondaryIndexQueryOperation.Query.Builder withRegexTermFilter(BinaryValue filter)

Set the regex to filter result terms by for this query.

Parameters:

filter - the regex to filter terms by.

Returns:

a reference to this object.

withTimeout

public SecondaryIndexQueryOperation.Query.Builder withTimeout(int timeout)

Set the timeout for the query.

Sets the server-side timeout value for this query.

Parameters:

timeout -

Returns:

a reference to this object.

withCoverageContext

public SecondaryIndexQueryOperation.Query.Builder withCoverageContext(byte[] coverageContext)

Set the coverage context for the query

Parameters:

coverageContext -

Returns:

a reference to this object.

withReturnBody

public SecondaryIndexQueryOperation.Query.Builder withReturnBody(boolean returnBody)

Set whether to return list of RiakObjects inside the response. This option could be used only if target Riak instance supports parallel extract feature (such as RiakTS).

Parameters:

returnBody - true to return data inside response

Returns:

a reference to this object.

build

public SecondaryIndexQueryOperation.Query build()