com.basho.riak.client.core.operations

Class FetchOperation.Builder

java.lang.Object

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

Enclosing class:

FetchOperation

public static class FetchOperation.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(Location location) Construct a FetchOperation that will retrieve an object from Riak stored at the provided Location.

Method Summary

Modifier and Type	Method and Description
FetchOperation	build()
FetchOperation.Builder	withBasicQuorum(boolean useBasicQuorum) Set the basic_quorum value.
FetchOperation.Builder	withHeadOnly(boolean headOnly) Return only the metadata.
FetchOperation.Builder	withIfNotModified(byte[] vclock) Do not return the object if the supplied vclock matches.
FetchOperation.Builder	withNotFoundOK(boolean notFoundOk) Set the not_found_ok value.
FetchOperation.Builder	withNVal(int nval) Set the n_val for this operation.
FetchOperation.Builder	withPr(int pr) Set the PR value for this query.
FetchOperation.Builder	withR(int r) Set the R value for this FetchOperation.
FetchOperation.Builder	withReturnDeletedVClock(boolean returnDeletedVClock) Set whether to return tombstones.
FetchOperation.Builder	withSloppyQuorum(boolean sloppyQuorum) Set whether to use sloppy_quorum.
FetchOperation.Builder	withTimeout(int timeout) Set a timeout for this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Location location)

Construct a FetchOperation that will retrieve an object from Riak stored at the provided Location.

Parameters:

location - the location of the object in Riak to fetch.

Method Detail

withR

public FetchOperation.Builder withR(int r)

Set the R value for this FetchOperation. If not asSet the bucket default is used.

Parameters:

r - the R value.

Returns:

a reference to this object.

withPr

public FetchOperation.Builder withPr(int pr)

Set the PR value for this query. If not asSet the bucket default is used.

Parameters:

pr - the PR value.

Returns:

a reference to this object.

withNotFoundOK

public FetchOperation.Builder withNotFoundOK(boolean notFoundOk)

Set the not_found_ok value.

If true a vnode returning notfound for a key increments the r tally. False is higher consistency, true is higher availability.

If not asSet the bucket default is used.

Parameters:

notFoundOk - the not_found_ok value.

Returns:

a reference to this object.

withBasicQuorum

public FetchOperation.Builder withBasicQuorum(boolean useBasicQuorum)

Set the basic_quorum value.

The parameter controls whether a read request should return early in some fail cases. E.g. If a quorum of nodes has already returned notfound/error, don't wait around for the rest.

Parameters:

useBasicQuorum - the basic_quorum value.

Returns:

a reference to this object.

withReturnDeletedVClock

public FetchOperation.Builder withReturnDeletedVClock(boolean returnDeletedVClock)

Set whether to return tombstones.

Parameters:

returnDeletedVClock - true to return tombstones, false otherwise.

Returns:

a reference to this object.

withHeadOnly

public FetchOperation.Builder withHeadOnly(boolean headOnly)

Return only the metadata.

Causes Riak to only return the metadata for the object. The value will be asSet to null.

Parameters:

headOnly - true to return only metadata.

Returns:

a reference to this object.

withIfNotModified

public FetchOperation.Builder withIfNotModified(byte[] vclock)

Do not return the object if the supplied vclock matches.

Parameters:

vclock - the vclock to match on

Returns:

a refrence to this object.

withTimeout

public FetchOperation.Builder withTimeout(int timeout)

Set a timeout for this operation.

Parameters:

timeout - a timeout in milliseconds.

Returns:

a reference to this object.

withNVal

public FetchOperation.Builder withNVal(int nval)

Set the n_val for this operation.

Do not use this unless you understand the ramifications

Parameters:

nval - the n_val value

Returns:

a reference to this object.

withSloppyQuorum

public FetchOperation.Builder withSloppyQuorum(boolean sloppyQuorum)

Set whether to use sloppy_quorum.

Do not use this unless you understand the ramifications

Parameters:

sloppyQuorum - true to use sloppy_quorum

Returns:

a reference to this object.

build

public FetchOperation build()