Class RemoveOptions
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class RemoveOptions : object, ITimeoutOptions, IKeyValueOptions
Fields
| Improve this Doc View SourceDefaultReadOnly
Declaration
public static readonly RemoveOptions.ReadOnly DefaultReadOnly
Field Value
Type | Description |
---|---|
RemoveOptions.ReadOnly |
Methods
| Improve this Doc View SourceAsReadOnly()
Declaration
public RemoveOptions.ReadOnly AsReadOnly()
Returns
Type | Description |
---|---|
RemoveOptions.ReadOnly |
CancellationToken(CancellationToken)
A CancellationToken(CancellationToken) for cooperative cancellation.
Declaration
public RemoveOptions CancellationToken(CancellationToken token)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | token |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |
Cas(UInt64)
Compare and Set value for optimistic locking of a document.
Declaration
public RemoveOptions Cas(ulong cas)
Parameters
Type | Name | Description |
---|---|---|
UInt64 | cas | A |
Returns
Type | Description |
---|---|
RemoveOptions | An options object for chaining. |
Deconstruct(out UInt64, out ReplicateTo, out PersistTo, out DurabilityLevel, out Nullable<TimeSpan>, out CancellationToken, out IRetryStrategy, out IRequestSpan)
Declaration
public void Deconstruct(out ulong cas, out ReplicateTo replicateTo, out PersistTo persistTo, out DurabilityLevel durabilityLevel, out TimeSpan? timeout, out CancellationToken token, out IRetryStrategy retryStrategy, out IRequestSpan requestSpan)
Parameters
Type | Name | Description |
---|---|---|
UInt64 | cas | |
ReplicateTo | replicateTo | |
PersistTo | persistTo | |
DurabilityLevel | durabilityLevel | |
Nullable<TimeSpan> | timeout | |
CancellationToken | token | |
IRetryStrategy | retryStrategy | |
IRequestSpan | requestSpan |
Durability(DurabilityLevel)
The durability level required for persisting a JSON document across the cluster.
Declaration
public RemoveOptions Durability(DurabilityLevel durabilityLevel)
Parameters
Type | Name | Description |
---|---|---|
DurabilityLevel | durabilityLevel | The Couchbase.KeyValue.RemoveOptions.DurabilityLevel required for persistance. |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |
Durability(PersistTo, ReplicateTo)
The durability level required for persisting a JSON document across the cluster.
Declaration
public RemoveOptions Durability(PersistTo persistTo, ReplicateTo replicateTo)
Parameters
Type | Name | Description |
---|---|---|
PersistTo | persistTo | The durability requirement for persistence. |
ReplicateTo | replicateTo | The durability requirement for replication. |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |
RequestSpan(IRequestSpan)
Inject an external span which will the be the parent span of the internal span(s).
Declaration
public RemoveOptions RequestSpan(IRequestSpan span)
Parameters
Type | Name | Description |
---|---|---|
IRequestSpan | span | An IRequestSpan |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |
RetryStrategy(IRetryStrategy)
Inject a custom IRetryStrategy.
Declaration
public RemoveOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Type | Name | Description |
---|---|---|
IRetryStrategy | retryStrategy |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |
Timeout(TimeSpan)
The time in which the operation will timeout if it does not complete.
Declaration
public RemoveOptions Timeout(TimeSpan timeout)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | timeout |
Returns
Type | Description |
---|---|
RemoveOptions | An options instance for chaining. |