com.basho.riak.client.core.operations

Class SecondaryIndexQueryOperation.Builder

java.lang.Object

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

Enclosing class:

SecondaryIndexQueryOperation

public static class SecondaryIndexQueryOperation.Builder
extends Object

Builder that constructs a QueryOperation.

Constructor Summary

Constructors

Constructor and Description
Builder(SecondaryIndexQueryOperation.Query query) Constructs a builder for a QueryOperation.

Method Summary

Modifier and Type	Method and Description
SecondaryIndexQueryOperation	build() Construct a new QueryOperation.
SecondaryIndexQueryOperation.Builder	streamResults(boolean streamResults) Set the streamResults flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(SecondaryIndexQueryOperation.Query query)

Constructs a builder for a QueryOperation. The index name must be the complete name with the _int or _bin suffix.

Parameters:

query - A 2i query.

Method Detail

streamResults

public SecondaryIndexQueryOperation.Builder streamResults(boolean streamResults)

Set the streamResults flag.

If unset or false, the entire result set will be available through the FutureOperation.get() method once the operation is complete.

If set to true, results will be pushed to the queue available through the PBStreamingFutureOperation.getResultsQueue() method as soon as they are available.

Parameters:

streamResults - whether to stream results to FutureOperation.get()(false), or PBStreamingFutureOperation.getResultsQueue()(true)

Returns:

A reference to this object.

build

public SecondaryIndexQueryOperation build()

Construct a new QueryOperation.

Returns:

a QueryOperation