Class AnalyticsOptions
- java.lang.Object
-
- com.couchbase.client.java.CommonOptions<AnalyticsOptions>
-
- com.couchbase.client.java.analytics.AnalyticsOptions
-
public class AnalyticsOptions extends CommonOptions<AnalyticsOptions>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
AnalyticsOptions.Built
-
Nested classes/interfaces inherited from class com.couchbase.client.java.CommonOptions
CommonOptions.BuiltCommonOptions
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AnalyticsOptions
analyticsOptions()
AnalyticsOptions.Built
build()
AnalyticsOptions
clientContextId(String clientContextId)
AnalyticsOptions
parameters(JsonArray positional)
Positional parameters if the query is parameterized with position numbersAnalyticsOptions
parameters(JsonObject named)
Named parameters if the query is parameterized with custom namesAnalyticsOptions
priority(int priority)
AnalyticsOptions
rawParam(String key, Object value)
AnalyticsOptions
scanConsistency(ScanConsistency scanConsistency)
Scan consistency for the query-
Methods inherited from class com.couchbase.client.java.CommonOptions
retryStrategy, self, timeout
-
-
-
-
Method Detail
-
analyticsOptions
public static AnalyticsOptions analyticsOptions()
-
priority
public AnalyticsOptions priority(int priority)
-
clientContextId
public AnalyticsOptions clientContextId(String clientContextId)
-
scanConsistency
public AnalyticsOptions scanConsistency(ScanConsistency scanConsistency)
Scan consistency for the query- Parameters:
scanConsistency
- the index scan consistency to be used- Returns:
QueryOptions
for further chaining
-
parameters
public AnalyticsOptions parameters(JsonObject named)
Named parameters if the query is parameterized with custom names- Parameters:
named
-JsonObject
with name as key- Returns:
- this
QueryOptions
for chaining.
-
parameters
public AnalyticsOptions parameters(JsonArray positional)
Positional parameters if the query is parameterized with position numbers- Parameters:
positional
-JsonArray
in the same order as positions- Returns:
- this
QueryOptions
for chaining.
-
rawParam
public AnalyticsOptions rawParam(String key, Object value)
-
build
@Internal public AnalyticsOptions.Built build()
-
-