Class GetAllReplicasOptions

Optional parameters for GetAllReplicasAsync(string, GetAllReplicasOptions?)

Inheritance

object

GetAllReplicasOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class GetAllReplicasOptions

Constructors

View Source

GetAllReplicasOptions()

Declaration

public GetAllReplicasOptions()

Fields

View Source

DefaultReadOnly

Declaration

public static readonly GetAllReplicasOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
GetAllReplicasOptions.ReadOnly

Properties

View Source

Default

Declaration

public static GetAllReplicasOptions Default { get; }

Property Value

Type	Description
GetAllReplicasOptions

Methods

View Source

AsReadOnly()

Declaration

public GetAllReplicasOptions.ReadOnly AsReadOnly()

Returns

Type	Description
GetAllReplicasOptions.ReadOnly

View Source

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public GetAllReplicasOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
GetAllReplicasOptions	A GetAllReplicasOptions 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 GetAllReplicasOptions ReadPreference(ReadPreference readPreference)

Parameters

Type	Name	Description
ReadPreference	readPreference	The read preference.

Returns

Type	Description
GetAllReplicasOptions	This for method chaining.

View Source

RequestSpan(IRequestSpan)

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

Declaration

public GetAllReplicasOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
GetAllReplicasOptions	A GetAllReplicasOptions instance for chaining.

View Source

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public GetAllReplicasOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
GetAllReplicasOptions	A GetAllReplicasOptions instance for chaining.

View Source

Transcoder(ITypeTranscoder?)

Inject a ITypeTranscoder other than the default JsonTranscoder.

Declaration

public GetAllReplicasOptions Transcoder(ITypeTranscoder? transcoder)

Parameters

Type	Name	Description
ITypeTranscoder	transcoder

Returns

Type	Description
GetAllReplicasOptions	A GetAllReplicasOptions instance for chaining.