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

Class DeleteValue.Builder

java.lang.Object

com.basho.riak.client.api.commands.kv.KvBuilderBase<DeleteValue>

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

Enclosing class:

DeleteValue

public static class DeleteValue.Builder
extends KvBuilderBase<DeleteValue>

Used to construct a DeleteValue command.

Field Summary

Fields inherited from class com.basho.riak.client.api.commands.kv.KvBuilderBase

location

Constructor Summary

Constructors

Constructor and Description
Builder(Location location) Construct a Builder for a DeleteValue command.

Method Summary

Modifier and Type	Method and Description
DeleteValue	build() Construct a DeleteValue object.
<T> DeleteValue.Builder	withOption(DeleteValue.Option<T> option, T value) Add a delete option.
DeleteValue.Builder	withTimeout(int timeout) Set the Riak-side timeout value.
DeleteValue.Builder	withVClock(VClock vClock) Specify the VClock to use when deleting the object from Riak.

Methods inherited from class com.basho.riak.client.api.commands.kv.KvBuilderBase

addOption

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 Builder for a DeleteValue command.

Parameters:

location - the location of the object in Riak

Method Detail

withVClock

public DeleteValue.Builder withVClock(VClock vClock)

Specify the VClock to use when deleting the object from Riak.

Parameters:

vClock - the vclock

Returns:

this

withOption

public <T> DeleteValue.Builder withOption(DeleteValue.Option<T> option,
                                          T value)

Add a delete option.

Type Parameters:

T - the type required by the option

Parameters:

option - the option

value - the value associated with the option

Returns:

a reference to this object

withTimeout

public DeleteValue.Builder withTimeout(int timeout)

Set the Riak-side timeout value.

By default, riak has a 60s timeout for operations. Setting this value will override that default for this operation.

Parameters:

timeout - the timeout in milliseconds to be sent to riak.

Returns:

a reference to this object.

build

public DeleteValue build()

Construct a DeleteValue object.

Specified by:

build in class KvBuilderBase<DeleteValue>

Returns:

a new DeleteValue instance.