com.couchbase.client.java.analytics

Class AnalyticsParams

java.lang.Object

com.couchbase.client.java.analytics.AnalyticsParams

All Implemented Interfaces:

Serializable

@InterfaceStability.Uncommitted
 @InterfaceAudience.Public
public class AnalyticsParams
extends Object
implements Serializable

Parameters for Analytics Queries.

Since:

2.4.3

Author:

Michael Nitschinger

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static AnalyticsParams	build() Start building a AnalyticsParams, allowing to customize an Analytics requests.
boolean	hasServerSideTimeout() Helper method to check if a custom server side timeout has been applied on the params.
void	injectParams(JsonObject queryJson) Modifies the given Analytics query (as a JsonObject) to reflect these N1qlParams.
AnalyticsParams	rawParam(String name, Object value) Allows to specify an arbitrary, raw Analytics param.
AnalyticsParams	serverSideTimeout(long timeout, TimeUnit unit) Sets a maximum timeout for processing on the server side.
AnalyticsParams	withContextId(String clientContextId) Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

Methods inherited from class java.lang.Object

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

Method Detail

injectParams

public void injectParams(JsonObject queryJson)

Modifies the given Analytics query (as a JsonObject) to reflect these N1qlParams.

Parameters:

queryJson - the Analytics query

withContextId

public AnalyticsParams withContextId(String clientContextId)

Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

Parameters:

clientContextId - the client context ID (null to send none)

Returns:

this AnalyticsParams for chaining.

serverSideTimeout

public AnalyticsParams serverSideTimeout(long timeout,
                                         TimeUnit unit)

Sets a maximum timeout for processing on the server side.

Parameters:

timeout - the duration of the timeout.

unit - the unit of the timeout, from nanoseconds to hours.

Returns:

this AnalyticsParams for chaining.

rawParam

@InterfaceStability.Uncommitted
public AnalyticsParams rawParam(String name,
                                                                Object value)

Allows to specify an arbitrary, raw Analytics param.

Use with care and only provide options that are supported by the server and are not exposed as part of the overall stable API in the AnalyticsParams class.

Parameters:

name - the name of the property.

value - the value of the property, only JSON value types are supported.

Returns:

this AnalyticsParams for chaining.

hasServerSideTimeout

public boolean hasServerSideTimeout()

Helper method to check if a custom server side timeout has been applied on the params.

Returns:

true if it has, false otherwise.

build

public static AnalyticsParams build()

Start building a AnalyticsParams, allowing to customize an Analytics requests.

Returns:

a new AnalyticsParams