com.basho.riak.client.api.commands.kv

Class FullBucketRead.Builder

java.lang.Object

com.basho.riak.client.api.commands.kv.FullBucketRead.Builder

Enclosing class:

FullBucketRead

public static class FullBucketRead.Builder
extends Object

Builder used to construct a FullBucketRead command.

Constructor Summary

Constructors

Constructor and Description
Builder(Namespace namespace) Construct a Builder for a FullBucketRead with a cover context.
Builder(Namespace namespace, byte[] coverageContext) Construct a Builder for a FullBucketRead with a cover context.

Method Summary

Modifier and Type	Method and Description
FullBucketRead	build() Construct the query.
FullBucketRead.Builder	withContinuation(BinaryValue continuation) Set the continuation for this query.
FullBucketRead.Builder	withMaxResults(Integer maxResults) Set the maximum number of results returned by the query.
FullBucketRead.Builder	withPaginationSort(boolean orderByKey) Set whether to sort the results of a non-paginated 2i query.
FullBucketRead.Builder	withReturnBody(boolean returnBody) Return the object (including any siblings).

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)

Construct a Builder for a FullBucketRead with a cover context.

Note that this command mustn't be used without coverage context for querying buckets that contain a big amount of data.

Builder

public Builder(Namespace namespace,
               byte[] coverageContext)

Construct a Builder for a FullBucketRead with a cover context.

Note that in case when query executed on the Riak node other than the one specified by the coverage context, nothing will be returned.

Method Detail

withReturnBody

public FullBucketRead.Builder withReturnBody(boolean returnBody)

Return the object (including any siblings).

Parameters:

returnBody - true to return the object.

Returns:

a reference to this object.

withContinuation

public FullBucketRead.Builder withContinuation(BinaryValue continuation)

Set the continuation for this query.

The continuation is returned by a previous paginated query.

Parameters:

continuation -

Returns:

a reference to this object.

withMaxResults

public FullBucketRead.Builder withMaxResults(Integer maxResults)

Set the maximum number of results returned by the query.

Parameters:

maxResults - the number of results.

Returns:

a reference to this object.

withPaginationSort

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

build

public FullBucketRead build()

Construct the query.

Returns:

a new FullBucketRead