Class GetAnyReplicaOptions

Optional parameters for GetAnyReplicaAsync(string, GetAnyReplicaOptions?)

Inheritance
object
GetAnyReplicaOptions
Inherited Members
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class GetAnyReplicaOptions

Constructors

View Source

GetAnyReplicaOptions()

Declaration
public GetAnyReplicaOptions()

Fields

View Source

DefaultReadOnly

Declaration
public static readonly GetAnyReplicaOptions.ReadOnly DefaultReadOnly
Field Value
Type Description
GetAnyReplicaOptions.ReadOnly

Properties

View Source

Default

Declaration
public static GetAnyReplicaOptions Default { get; }
Property Value
Type Description
GetAnyReplicaOptions

Methods

View Source

AsReadOnly()

Declaration
public GetAnyReplicaOptions.ReadOnly AsReadOnly()
Returns
Type Description
GetAnyReplicaOptions.ReadOnly
View Source

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration
public GetAnyReplicaOptions CancellationToken(CancellationToken token)
Parameters
Type Name Description
CancellationToken token
Returns
Type Description
GetAnyReplicaOptions

A GetAnyReplicaOptions instance for chaining.
View Source

Deconstruct(out CancellationToken, out ITypeTranscoder?, out IRetryStrategy?, out IRequestSpan?, out InternalReadPreference)

Declaration
public void Deconstruct(out CancellationToken token, out ITypeTranscoder? transcoder, out IRetryStrategy? retryStrategy, out IRequestSpan? requestSpan, out InternalReadPreference readPreference)
Parameters
Type Name Description
CancellationToken token
ITypeTranscoder transcoder
IRetryStrategy retryStrategy
IRequestSpan requestSpan
InternalReadPreference readPreference
View Source

ReadPreference(ReadPreference)

Sets whether the operation should only target Nodes in the server group specified in the ClusterOptions.

Declaration
public GetAnyReplicaOptions ReadPreference(ReadPreference readPreference)
Parameters
Type Name Description
ReadPreference readPreference

The read preference.
Returns
Type Description
GetAnyReplicaOptions

This for method chaining.
View Source

RequestSpan(IRequestSpan)

Declaration
public GetAnyReplicaOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span
Returns
Type Description
GetAnyReplicaOptions
View Source

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration
public GetAnyReplicaOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Type Name Description
IRetryStrategy retryStrategy
Returns
Type Description
GetAnyReplicaOptions

A GetAnyReplicaOptions instance for chaining.
View Source

Transcoder(ITypeTranscoder?)

Inject a ITypeTranscoder other than the default JsonTranscoder.

Declaration
public GetAnyReplicaOptions Transcoder(ITypeTranscoder? transcoder)
Parameters
Type Name Description
ITypeTranscoder transcoder
Returns
Type Description
GetAnyReplicaOptions

A GetAnyReplicaOptions instance for chaining.