com.basho.riak.client.core.operations

Class SearchOperation

java.lang.Object

com.basho.riak.client.core.FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

com.basho.riak.client.core.operations.SearchOperation

All Implemented Interfaces:

RiakFuture<SearchOperation.Response,BinaryValue>, Future<SearchOperation.Response>

public class SearchOperation
extends FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

A Riak Search or Yokozuna query operation.

Due to the nature of both Riak Search and Yokozuna, all Strings must be UTF-8 encoded.

This operation will fail if search is not enabled or the index does not exist.

Since:

2.0

Author:

Brian Roach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchOperation.Builder
static class	SearchOperation.Response

Method Summary

Modifier and Type	Method and Description
protected SearchOperation.Response	convert(List<RiakSearchPB.RpbSearchQueryResp> rawResponse)
protected RiakMessage	createChannelMessage()
protected RiakSearchPB.RpbSearchQueryResp	decode(RiakMessage rawMessage)
BinaryValue	getQueryInfo() Returns information related to the operation performed.

Methods inherited from class com.basho.riak.client.core.FutureOperation

addListener, await, await, cancel, cause, channelMessage, checkAndGetSingleResponse, done, get, get, getNow, isCancelled, isDone, isSuccess, processBatchMessage, processMessage, removeListener, setComplete, setResponse

Methods inherited from class java.lang.Object

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

Method Detail

convert

protected SearchOperation.Response convert(List<RiakSearchPB.RpbSearchQueryResp> rawResponse)

Specified by:

convert in class FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

createChannelMessage

protected RiakMessage createChannelMessage()

Specified by:

createChannelMessage in class FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

decode

protected RiakSearchPB.RpbSearchQueryResp decode(RiakMessage rawMessage)

Specified by:

decode in class FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

getQueryInfo

public BinaryValue getQueryInfo()

Description copied from interface: RiakFuture

Returns information related to the operation performed.

Useful in async operations when you want to know what operation this future refers to.

Specified by:

getQueryInfo in interface RiakFuture<SearchOperation.Response,BinaryValue>

Specified by:

getQueryInfo in class FutureOperation<SearchOperation.Response,RiakSearchPB.RpbSearchQueryResp,BinaryValue>

Returns:

Information pertaining to the operation attached to this future.