Class AnalyticsOptions

Inheritance

object

AnalyticsOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Analytics

Assembly: Couchbase.NetClient.dll

Syntax

public class AnalyticsOptions

Fields

DefaultReadOnly

Declaration

public static readonly AnalyticsOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
AnalyticsOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public AnalyticsOptions.ReadOnly AsReadOnly()

Returns

Type	Description
AnalyticsOptions.ReadOnly

CancellationToken(CancellationToken)

A token for controlling cooperative cancellation of the query.

Declaration

public AnalyticsOptions CancellationToken(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A CancellationToken(CancellationToken) for controlling query cancellation

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

ClientContextId(string)

Declaration

public AnalyticsOptions ClientContextId(string clientContextId)

Parameters

Type	Name	Description
string	clientContextId

Returns

Type	Description
AnalyticsOptions

Deconstruct(out string?, out IReadOnlyDictionary<string, object>, out IReadOnlyList<object>, out CancellationToken, out AnalyticsScanConsistency, out bool, out int, out TimeSpan?, out IRetryStrategy?, out IRequestSpan?, out string?, out string?, out string?)

Declaration

public void Deconstruct(out string? clientContextIdValue, out IReadOnlyDictionary<string, object> namedParameters, out IReadOnlyList<object> positionalParameters, out CancellationToken token, out AnalyticsScanConsistency scanConsistencyValue, out bool readonlyValue, out int priorityValue, out TimeSpan? timeoutValue, out IRetryStrategy? retryStrategyValue, out IRequestSpan? requestSpanValue, out string? queryContext, out string? bucketName, out string? scopeName)

Parameters

Type	Name	Description
string	clientContextIdValue
IReadOnlyDictionary<string, object>	namedParameters
IReadOnlyList<object>	positionalParameters
CancellationToken	token
AnalyticsScanConsistency	scanConsistencyValue
bool	readonlyValue
int	priorityValue
TimeSpan?	timeoutValue
IRetryStrategy	retryStrategyValue
IRequestSpan	requestSpanValue
string	queryContext
string	bucketName
string	scopeName

Parameter(object)

Specifies positional parameters.

Declaration

public AnalyticsOptions Parameter(object value)

Parameters

Type	Name	Description
object	value	The value of the positional parameter.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

Parameter(string, object)

Specifies named parameters.

Declaration

public AnalyticsOptions Parameter(string parameterName, object value)

Parameters

Type	Name	Description
string	parameterName	The named parameter value.
object	value	The named parameter key or name.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

Priority(bool)

Allows to give certain requests higher priority than others.

Declaration

public AnalyticsOptions Priority(bool priority)

Parameters

Type	Name	Description
bool	priority	Set to true to prioritize the query.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

Raw(string, object)

Specifies values with their key and value as presented as part of the JSON payload.

Declaration

public AnalyticsOptions Raw(string key, object value)

Parameters

Type	Name	Description
string	key	The key of the raw parameter.
object	value	The value of the raw parameter.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

Readonly(bool)

Allows to specify if the query is readonly.

Declaration

public AnalyticsOptions Readonly(bool readOnly)

Parameters

Type	Name	Description
bool	readOnly

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

RequestSpan(IRequestSpan)

A parent or external span for tracing.

Declaration

public AnalyticsOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An external IRequestSpan implementation for tracing.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

RetryStrategy(IRetryStrategy)

Overrides the global IRetryStrategy defined in ClusterOptions for a request.

Declaration

public AnalyticsOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy	The IRetryStrategy to use for a single request.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

ScanConsistency(AnalyticsScanConsistency)

The AnalyticsScanConsistency you require for your analytics query.

Declaration

public AnalyticsOptions ScanConsistency(AnalyticsScanConsistency scanConsistency)

Parameters

Type	Name	Description
AnalyticsScanConsistency	scanConsistency	The AnalyticsScanConsistency for documents to be included in the analytics results.

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.

Timeout(TimeSpan)

Specifies how long to allow the operation to continue running before it is cancelled.

Declaration

public AnalyticsOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	A TimeSpan

Returns

Type	Description
AnalyticsOptions	A AnalyticsOptions object for chaining options.