Class GetAndLockOptions
Inheritance
System.Object
GetAndLockOptions
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class GetAndLockOptions : object, ITranscoderOverrideOptions, ITimeoutOptions, IKeyValueOptions
Fields
| Improve this Doc View SourceDefaultReadOnly
Declaration
public static readonly GetAndLockOptions.ReadOnly DefaultReadOnly
Field Value
Type | Description |
---|---|
GetAndLockOptions.ReadOnly |
Methods
| Improve this Doc View SourceAsReadOnly()
Declaration
public GetAndLockOptions.ReadOnly AsReadOnly()
Returns
Type | Description |
---|---|
GetAndLockOptions.ReadOnly |
CancellationToken(CancellationToken)
A CancellationToken(CancellationToken) for cooperative cancellation.
Declaration
public GetAndLockOptions CancellationToken(CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | token |
Returns
Type | Description |
---|---|
GetAndLockOptions | An options instance for chaining. |
Deconstruct(out Nullable<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 |
---|---|---|
System.Nullable<TimeSpan> | timeout | |
CancellationToken | token | |
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 GetAndLockOptions RequestSpan(IRequestSpan span)
Parameters
Type | Name | Description |
---|---|---|
IRequestSpan | span | An IRequestSpan |
Returns
Type | Description |
---|---|
GetAndLockOptions | An options instance for chaining. |
RetryStrategy(IRetryStrategy)
Inject a custom IRetryStrategy.
Declaration
public GetAndLockOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Type | Name | Description |
---|---|---|
IRetryStrategy | retryStrategy |
Returns
Type | Description |
---|---|
GetAndLockOptions | An options instance for chaining. |
Timeout(TimeSpan)
The time in which the operation will timeout if it does not complete.
Declaration
public GetAndLockOptions Timeout(TimeSpan timeout)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | timeout |
Returns
Type | Description |
---|---|
GetAndLockOptions | An options instance for chaining. |
Transcoder(ITypeTranscoder)
Inject a ITypeTranscoder other than the default JsonTranscoder.
Declaration
public GetAndLockOptions Transcoder(ITypeTranscoder transcoder)
Parameters
Type | Name | Description |
---|---|---|
ITypeTranscoder | transcoder |
Returns
Type | Description |
---|---|
GetAndLockOptions | An options instance for chaining. |