Class UnlockOptions
Inheritance
System.Object
UnlockOptions
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class UnlockOptions : object, ITimeoutOptions, IKeyValueOptions
Fields
| Improve this Doc View SourceDefaultReadOnly
Declaration
public static readonly UnlockOptions.ReadOnly DefaultReadOnly
Field Value
Type | Description |
---|---|
UnlockOptions.ReadOnly |
Methods
| Improve this Doc View SourceAsReadOnly()
Declaration
public UnlockOptions.ReadOnly AsReadOnly()
Returns
Type | Description |
---|---|
UnlockOptions.ReadOnly |
CancellationToken(CancellationToken)
A CancellationToken(CancellationToken) for cooperative cancellation.
Declaration
public UnlockOptions CancellationToken(CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | token |
Returns
Type | Description |
---|---|
UnlockOptions | An options instance for chaining. |
Deconstruct(out Nullable<TimeSpan>, out CancellationToken, out IRetryStrategy, out IRequestSpan)
Declaration
public void Deconstruct(out TimeSpan? timeout, out CancellationToken token, out IRetryStrategy retryStrategy, out IRequestSpan requestSpan)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<TimeSpan> | timeout | |
CancellationToken | token | |
IRetryStrategy | retryStrategy | |
IRequestSpan | requestSpan |
RequestSpan(IRequestSpan)
Inject an external span which will the be the parent span of the internal span(s).
Declaration
public UnlockOptions RequestSpan(IRequestSpan span)
Parameters
Type | Name | Description |
---|---|---|
IRequestSpan | span | An IRequestSpan |
Returns
Type | Description |
---|---|
UnlockOptions | An options instance for chaining. |
RetryStrategy(IRetryStrategy)
Inject a custom IRetryStrategy.
Declaration
public UnlockOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Type | Name | Description |
---|---|---|
IRetryStrategy | retryStrategy |
Returns
Type | Description |
---|---|
UnlockOptions | An options instance for chaining. |
Timeout(TimeSpan)
The time in which the operation will timeout if it does not complete.
Declaration
public UnlockOptions Timeout(TimeSpan timeout)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | timeout |
Returns
Type | Description |
---|---|
UnlockOptions | An options instance for chaining. |