com.basho.riak.client.api.commands.buckets

Class ListBuckets

java.lang.Object

com.basho.riak.client.api.RiakCommand<R,I>

com.basho.riak.client.api.GenericRiakCommand<R,I,CoreR,CoreI>

com.basho.riak.client.api.StreamableRiakCommand<R,I,CoreR,I>

com.basho.riak.client.api.StreamableRiakCommand.StreamableRiakCommandWithSameInfo<ListBuckets.Response,BinaryValue,ListBucketsOperation.Response>

com.basho.riak.client.api.commands.buckets.ListBuckets

public final class ListBuckets
extends StreamableRiakCommand.StreamableRiakCommandWithSameInfo<ListBuckets.Response,BinaryValue,ListBucketsOperation.Response>

Command used to list the buckets contained in a bucket type.

 ListBuckets lb = new ListBuckets.Builder("my_type").build();
 ListBuckets.Response resp = client.execute(lb);
 for (Namespace ns : response)
 {
     System.out.println(ns.getBucketName());
 }

You can also stream the results back before the operation is fully complete. This reduces the time between executing the operation and seeing a result, and reduces overall memory usage if the iterator is consumed quickly enough. The result iterable can only be iterated once though. If the thread is interrupted while the iterator is polling for more results, a RuntimeException will be thrown.

 ListBuckets lb = new ListBuckets.Builder("my_type").build();
 final RiakFuture<ListBuckets.StreamingResponse, BinaryValue> streamFuture =
     client.executeAsyncStreaming(lb, 200);
 final ListBuckets.StreamingResponse streamingResponse = streamFuture.get();
 for (Namespace ns : streamingResponse)
 {
     System.out.println(ns.getBucketName());
 }

Since:

2.0

Author:

Dave Rusek , Alex Moore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBuckets.Builder Builder for a ListBuckets command.
static class	ListBuckets.Response A response from a ListBuckets command.

Nested classes/interfaces inherited from class com.basho.riak.client.api.StreamableRiakCommand

StreamableRiakCommand.StreamableResponse<T,S>, StreamableRiakCommand.StreamableRiakCommandWithSameInfo<R extends StreamableRiakCommand.StreamableResponse,I,CoreR>

Nested classes/interfaces inherited from class com.basho.riak.client.api.GenericRiakCommand

GenericRiakCommand.GenericRiakCommandWithSameInfo<R,I,CoreR>

Method Summary

Modifier and Type	Method and Description
protected ListBucketsOperation	buildCoreOperation(boolean streamResults)
protected ListBuckets.Response	convertResponse(FutureOperation<ListBucketsOperation.Response,?,BinaryValue> request, ListBucketsOperation.Response coreResponse)
protected ListBuckets.Response	createResponse(int timeout, StreamingRiakFuture<ListBucketsOperation.Response,BinaryValue> coreFuture)

Methods inherited from class com.basho.riak.client.api.StreamableRiakCommand.StreamableRiakCommandWithSameInfo

convertInfo

Methods inherited from class com.basho.riak.client.api.StreamableRiakCommand

buildCoreOperation, executeAsyncStreaming

Methods inherited from class com.basho.riak.client.api.GenericRiakCommand

executeAsync

Methods inherited from class com.basho.riak.client.api.RiakCommand

execute, execute

Methods inherited from class java.lang.Object

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

Method Detail

convertResponse

protected ListBuckets.Response convertResponse(FutureOperation<ListBucketsOperation.Response,?,BinaryValue> request,
                                               ListBucketsOperation.Response coreResponse)

Specified by:

convertResponse in class GenericRiakCommand<ListBuckets.Response,BinaryValue,ListBucketsOperation.Response,BinaryValue>

createResponse

protected ListBuckets.Response createResponse(int timeout,
                                              StreamingRiakFuture<ListBucketsOperation.Response,BinaryValue> coreFuture)

Specified by:

createResponse in class StreamableRiakCommand<ListBuckets.Response,BinaryValue,ListBucketsOperation.Response,BinaryValue>

buildCoreOperation

protected ListBucketsOperation buildCoreOperation(boolean streamResults)

Specified by:

buildCoreOperation in class StreamableRiakCommand<ListBuckets.Response,BinaryValue,ListBucketsOperation.Response,BinaryValue>