Class LookupInAnyReplicaOptions
Inheritance
System.Object
LookupInAnyReplicaOptions
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class LookupInAnyReplicaOptions : object, ITimeoutOptions, ITranscoderOverrideOptions, IKeyValueOptions
Fields
| Improve this Doc View SourceDefaultReadOnly
Declaration
public static readonly LookupInOptions.ReadOnly DefaultReadOnly
Field Value
Type | Description |
---|---|
LookupInOptions.ReadOnly |
Methods
| Improve this Doc View SourceAsReadOnly()
Declaration
public LookupInOptions.ReadOnly AsReadOnly()
Returns
Type | Description |
---|---|
LookupInOptions.ReadOnly |
CancellationToken(CancellationToken)
A CancellationToken(CancellationToken) for cooperative cancellation.
Declaration
public LookupInAnyReplicaOptions CancellationToken(CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | token |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions | An options instance for chaining. |
Deconstruct(out Nullable<TimeSpan>, out CancellationToken, out ITypeSerializer, out ITypeTranscoder, out IRetryStrategy, out IRequestSpan)
Declaration
public void Deconstruct(out TimeSpan? timeout, out CancellationToken token, out ITypeSerializer serializer, out ITypeTranscoder transcoder, out IRetryStrategy retryStrategy, out IRequestSpan requestSpan)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<TimeSpan> | timeout | |
CancellationToken | token | |
ITypeSerializer | serializer | |
ITypeTranscoder | transcoder | |
IRetryStrategy | retryStrategy | |
IRequestSpan | requestSpan |
RequestSpan(IRequestSpan)
Inject an external span which will the be the parent span of the internal span(s).
Declaration
public LookupInAnyReplicaOptions RequestSpan(IRequestSpan span)
Parameters
Type | Name | Description |
---|---|---|
IRequestSpan | span | An IRequestSpan |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions | An options instance for chaining. |
RetryStrategy(IRetryStrategy)
Inject a custom IRetryStrategy.
Declaration
public LookupInAnyReplicaOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Type | Name | Description |
---|---|---|
IRetryStrategy | retryStrategy |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions | An options instance for chaining. |
Serializer(ITypeSerializer)
A custom ITypeSerializer implementation for serialization.
Declaration
public LookupInAnyReplicaOptions Serializer(ITypeSerializer serializer)
Parameters
Type | Name | Description |
---|---|---|
ITypeSerializer | serializer | A custom ITypeSerializer implementation for serialization. |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions | An options instance for chaining. |
Timeout(Nullable<TimeSpan>)
The time in which the operation will timeout if it does not complete.
Declaration
public LookupInAnyReplicaOptions Timeout(TimeSpan? timeout)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<TimeSpan> | timeout |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions | An options instance for chaining. |
Transcoder(ITypeTranscoder)
Only used internally for full doc gets which also need the expiry. Should not be used for JSON-based LookupIn ops. Not exposed for public consumption.
Declaration
public LookupInAnyReplicaOptions Transcoder(ITypeTranscoder transcoder)
Parameters
Type | Name | Description |
---|---|---|
ITypeTranscoder | transcoder |
Returns
Type | Description |
---|---|
LookupInAnyReplicaOptions |