Class DecrementOptions

Inheritance

object

DecrementOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class DecrementOptions

Fields

DefaultReadOnly

Declaration

public static readonly DecrementOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
DecrementOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public DecrementOptions.ReadOnly AsReadOnly()

Returns

Type	Description
DecrementOptions.ReadOnly

CancellationToken(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(ulong)

Declaration

[Obsolete("CAS is not supported by the server for the Increment operation.")]
public DecrementOptions Cas(ulong cas)

Parameters

Type	Name	Description
ulong	cas

Returns

Type	Description
DecrementOptions

Deconstruct(out ulong?, out ulong, out ReplicateTo, out PersistTo, out DurabilityLevel, out TimeSpan?, out CancellationToken, out TimeSpan, out IRequestSpan?, out IRetryStrategy?)

Declaration

public void Deconstruct(out ulong? initial, out ulong delta, out ReplicateTo replicateTo, out PersistTo persistTo, out DurabilityLevel durabilityLevel, out TimeSpan? timeout, out CancellationToken token, out TimeSpan expiry, out IRequestSpan? requestSpan, out IRetryStrategy? retryStrategy)

Parameters

Type	Name	Description
ulong?	initial
ulong	delta
ReplicateTo	replicateTo
PersistTo	persistTo
DurabilityLevel	durabilityLevel
TimeSpan?	timeout
CancellationToken	token
TimeSpan	expiry
IRequestSpan	requestSpan
IRetryStrategy	retryStrategy

Delta(ulong)

The value to decrement by.

Declaration

public DecrementOptions Delta(ulong delta)

Parameters

Type	Name	Description
ulong	delta	A ulong value to decrement by..

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 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(ulong)

The initial value to start from.

Declaration

public DecrementOptions Initial(ulong initial)

Parameters

Type	Name	Description
ulong	initial	A ulong inital value.

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.