com.basho.riak.client.core.operations

Class StoreOperation.Builder

java.lang.Object

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

Enclosing class:

StoreOperation

public static class StoreOperation.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(Location location) Constructs a builder for a StoreOperation
Builder(Namespace namespace) Constructs a builder for a StoreOperation.

Method Summary

Modifier and Type	Method and Description
StoreOperation	build()
StoreOperation.Builder	withAsis(boolean asis) Set the asis value for this operation.
StoreOperation.Builder	withContent(RiakObject content)
StoreOperation.Builder	withDw(int dw) Set the DW value for this StoreOperation.
StoreOperation.Builder	withIfNoneMatch(boolean ifNoneMatch) Set the if_none_match flag value for this StoreOperation.
StoreOperation.Builder	withIfNotModified(boolean ifNotModified) Set the if_not_modified flag for this StoreOperation.
StoreOperation.Builder	withNVal(int nval) Set the n_val value for this operation.
StoreOperation.Builder	withPw(int pw) Set the PW value for this StoreOperation.
StoreOperation.Builder	withReturnBody(boolean returnBody) Return the object after storing (including any siblings).
StoreOperation.Builder	withReturnHead(boolean returnHead) Return the metadata after storing the value.
StoreOperation.Builder	withSloppyQuorum(boolean sloppyQuorum) Set whether to use sloppy_quorum.
StoreOperation.Builder	withTimeout(int timeout) Set a timeout for this operation.
StoreOperation.Builder	withW(int w) Set the W value for this StoreOperation.

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)

Constructs a builder for a StoreOperation

Parameters:

location - The location in Riak at which to store.

Builder

public Builder(Namespace namespace)

Constructs a builder for a StoreOperation.

Supplying only a Namespace causes the key to be generated by Riak.

Parameters:

namespace - the namespace in Riak.

Method Detail

withContent

public StoreOperation.Builder withContent(RiakObject content)

withW

public StoreOperation.Builder withW(int w)

Set the W value for this StoreOperation. If not asSet the bucket default is used.

Parameters:

w - the W value.

Returns:

a reference to this object.

withDw

public StoreOperation.Builder withDw(int dw)

Set the DW value for this StoreOperation. If not asSet the bucket default is used.

Parameters:

dw - the DW value.

Returns:

a reference to this object.

withPw

public StoreOperation.Builder withPw(int pw)

Set the PW value for this StoreOperation. If not asSet the bucket default is used.

Parameters:

pw - the PW value.

Returns:

a reference to this object.

withReturnBody

public StoreOperation.Builder withReturnBody(boolean returnBody)

Return the object after storing (including any siblings).

Parameters:

returnBody - true to return the object.

Returns:

a reference to this object.

withReturnHead

public StoreOperation.Builder withReturnHead(boolean returnHead)

Return the metadata after storing the value.

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

Parameters:

returnHead - true to return only metadata.

Returns:

a reference to this object.

withIfNotModified

public StoreOperation.Builder withIfNotModified(boolean ifNotModified)

Set the if_not_modified flag for this StoreOperation.

Setting this to true means to update the value only if the vclock in the supplied object matches the one in the database.

Be aware there are several cases where this may not actually happen. Use of this feature is discouraged.

Parameters:

ifNotModified -

Returns:

a reference to this object.

withIfNoneMatch

public StoreOperation.Builder withIfNoneMatch(boolean ifNoneMatch)

Set the if_none_match flag value for this StoreOperation.

Setting this to true means store the value only if this bucket/key combination are not already defined.

Be aware that there are several cases where this may not actually happen. Use of this option is discouraged.

Parameters:

ifNoneMatch - the if_non-match value.

Returns:

a reference to this object.

withAsis

public StoreOperation.Builder withAsis(boolean asis)

Set the asis value for this operation.

Do not use this unless you understand the ramifications

Parameters:

asis - the asis value

Returns:

a reference to this object.

withTimeout

public StoreOperation.Builder withTimeout(int timeout)

Set a timeout for this operation.

Parameters:

timeout - a timeout in milliseconds.

Returns:

a reference to this object.

withNVal

public StoreOperation.Builder withNVal(int nval)

Set the n_val value 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 StoreOperation.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 StoreOperation build()