Class DecrementOptions
Namespace: Couchbase.KeyValue
Assembly: Couchbase.NetClient.dll
Syntax
public class DecrementOptions : object, ITimeoutOptions, IKeyValueOptionsMethods
| Improve this Doc View SourceCancellationToken(CancellationToken)
A CancellationToken(CancellationToken) for cooperative cancellation.
Declaration
public DecrementOptions CancellationToken(CancellationToken token)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | token |
Returns
| Type | Description |
|---|---|
| DecrementOptions | An options instance for chaining. |
Cas(UInt64)
Declaration
public DecrementOptions Cas(ulong cas)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | cas |
Returns
| Type | Description |
|---|---|
| DecrementOptions |
Delta(UInt64)
The value to decrement by.
Declaration
public DecrementOptions Delta(ulong delta)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | delta | A |
Returns
| Type | Description |
|---|---|
| DecrementOptions |
Durability(DurabilityLevel)
The durability level required for persisting a JSON document across the cluster.
Declaration
public DecrementOptions Durability(DurabilityLevel durabilityLevel)Parameters
| Type | Name | Description |
|---|---|---|
| DurabilityLevel | durabilityLevel | The Couchbase.KeyValue.DecrementOptions.DurabilityLevel required for persistance. |
Returns
| Type | Description |
|---|---|
| DecrementOptions | An options instance for chaining. |
Durability(PersistTo, ReplicateTo)
The durability level required for persisting a JSON document across the cluster.
Declaration
public DecrementOptions 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 |
|---|---|
| DecrementOptions | An options instance for chaining. |
Expiry(TimeSpan)
Sets the expiration for a document. By default, documents never expire - if overridden the value must be less than 50 years.
Declaration
public DecrementOptions Expiry(TimeSpan expiry)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | expiry | The time-to-live of the document. |
Returns
| Type | Description |
|---|---|
| DecrementOptions | An options object for chaining. |
Initial(UInt64)
The initial value to start from.
Declaration
public DecrementOptions Initial(ulong initial)Parameters
| Type | Name | Description |
|---|---|---|
| UInt64 | initial | A |
Returns
| Type | Description |
|---|---|
| DecrementOptions |
RequestSpan(IRequestSpan)
Declaration
public DecrementOptions RequestSpan(IRequestSpan span)Parameters
| Type | Name | Description |
|---|---|---|
| IRequestSpan | span |
Returns
| Type | Description |
|---|---|
| DecrementOptions |
RetryStrategy(IRetryStrategy)
Inject a custom IRetryStrategy.
Declaration
public DecrementOptions RetryStrategy(IRetryStrategy retryStrategy)Parameters
| Type | Name | Description |
|---|---|---|
| IRetryStrategy | retryStrategy |
Returns
| Type | Description |
|---|---|
| DecrementOptions | An options instance for chaining. |
Timeout(TimeSpan)
The time in which the operation will timeout if it does not complete.
Declaration
public DecrementOptions Timeout(TimeSpan timeout)Parameters
| Type | Name | Description |
|---|---|---|
| TimeSpan | timeout |
Returns
| Type | Description |
|---|---|
| DecrementOptions | An options instance for chaining. |