Package com.couchbase.analytics.client.java

Class QueryHandle

java.lang.Object

com.couchbase.analytics.client.java.QueryHandle

@ThreadSafe
public class QueryHandle
extends Object

Method Summary

Modifier and Type	Method	Description
void	cancel()
QueryStatus	fetchStatus()	Returns the query's current status.
QueryStatus	fetchStatus(Consumer<FetchStatusOptions> options)	Returns the query's current status.
static QueryHandle	fromSerialized(Cluster cluster, String serializedForm)
String	toSerialized()	Returns the serialized form of this query handle, suitable for persistence or transmission to another process.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

fetchStatus

public QueryStatus fetchStatus()

Returns the query's current status. Call this method to access the query result.

Throws:

QueryException - if the server response indicates an error occurred during query execution.

AnalyticsTimeoutException - if the server does not respond before the timeout.

AnalyticsException - if anything else went wrong while executing this request.

fetchStatus

public QueryStatus fetchStatus(Consumer<FetchStatusOptions> options)

Returns the query's current status. Call this method to access the query result.

cancel

public void cancel()

toSerialized

@Experimental
public String toSerialized()

Returns the serialized form of this query handle, suitable for persistence or transmission to another process.

Note: Since this is currently an experimental API, the serialized form is not guaranteed to be stable across library versions.

See Also:

• fromSerialized(Cluster, String)

fromSerialized

@Experimental
public static QueryHandle fromSerialized(Cluster cluster,
 String serializedForm)

See Also:

• toSerialized()

toString

public String toString()

Overrides:

toString in class Object