Class GetReplicaOptions

Optional parameters for GetReplicaAsync(string, GetReplicaStrategy, GetReplicaOptions?)

Inheritance
object
GetReplicaOptions
Inherited Members
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Uncommitted)]
public class GetReplicaOptions

Constructors

View Source

GetReplicaOptions()

Declaration
public GetReplicaOptions()

Fields

View Source

DefaultReadOnly

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

Properties

View Source

Default

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

Methods

View Source

AsReadOnly()

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

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

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

A GetReplicaOptions instance for chaining.
View Source

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

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

RequestSpan(IRequestSpan)

Inject an external span which will be the parent span of the internal span(s).

Declaration
public GetReplicaOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span

An IRequestSpan
Returns
Type Description
GetReplicaOptions

A GetReplicaOptions instance for chaining.
View Source

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

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

A GetReplicaOptions instance for chaining.
View Source

Timeout(TimeSpan)

The time in which the operation will timeout if it does not complete.

Declaration
public GetReplicaOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout
Returns
Type Description
GetReplicaOptions

A GetReplicaOptions instance for chaining.
View Source

Transcoder(ITypeTranscoder?)

Inject a ITypeTranscoder other than the default JsonTranscoder.

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

A GetReplicaOptions instance for chaining.