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

Class MultiFetch.Builder

java.lang.Object

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

Enclosing class:

MultiFetch

public static class MultiFetch.Builder
extends Object

Used to construct a MutiFetch command.

Constructor Summary

Constructors

Constructor and Description
MultiFetch.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
MultiFetch.Builder	addLocation(Location location) Add a location to the list of locations to retrieve as part of this multifetch operation.
MultiFetch.Builder	addLocations(Iterable<Location> location) Add a set of keys to the list of Locations to retrieve as part of this multifetch operation.
MultiFetch.Builder	addLocations(Location... location) Add a list of Locations to the list of locations to retrieve as part of this multifetch operation.
MultiFetch	build() Build a MultiFetch operation from this builder
MultiFetch.Builder	withMaxInFlight(int maxInFlight) Set the maximum number of requests to be in progress simultaneously.
<U> MultiFetch.Builder	withOption(FetchValue.Option<U> option, U value) A FetchValue.Option to use with each fetch operation.
MultiFetch.Builder	withTimeout(int timeout) Set the Riak-side timeout value.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiFetch.Builder

public MultiFetch.Builder()

Method Detail

addLocation

public MultiFetch.Builder addLocation(Location location)

Add a location to the list of locations to retrieve as part of this multifetch operation.

Parameters:

location - the location to add.

Returns:

this

addLocations

public MultiFetch.Builder addLocations(Location... location)

Add a list of Locations to the list of locations to retrieve as part of this multifetch operation.

Parameters:

location - a list of Locations

Returns:

a reference to this object

addLocations

public MultiFetch.Builder addLocations(Iterable<Location> location)

Add a set of keys to the list of Locations to retrieve as part of this multifetch operation.

Parameters:

location - an Iterable set of Locations.

Returns:

a reference to this object

withMaxInFlight

public MultiFetch.Builder withMaxInFlight(int maxInFlight)

Set the maximum number of requests to be in progress simultaneously.

As noted, Riak does not actually have "MultiFetch" functionality. This operation simulates it by sending multiple fetch requests. This parameter controls how many outstanding requests are allowed simultaneously.

Parameters:

maxInFlight - the max number of outstanding requests.

Returns:

a reference to this object.

withOption

public <U> MultiFetch.Builder withOption(FetchValue.Option<U> option,
                                U value)

A FetchValue.Option to use with each fetch operation.

Type Parameters:

U - the type of the option's value

Parameters:

option - an option

value - the option's associated value

Returns:

a reference to this object.

withTimeout

public MultiFetch.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 each fetch.

Parameters:

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

Returns:

a reference to this object.

build

public MultiFetch build()

Build a MultiFetch operation from this builder

Returns:

an initialized MultiFetch operation