Class AppendOptions

Inheritance

object

AppendOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class AppendOptions

Constructors

AppendOptions()

Declaration

public AppendOptions()

Fields

DefaultReadOnly

Declaration

public static readonly AppendOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
AppendOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public AppendOptions.ReadOnly AsReadOnly()

Returns

Type	Description
AppendOptions.ReadOnly

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public AppendOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
AppendOptions	An options instance for chaining.

Cas(ulong)

Compare and Set value for optimistic locking of a document.

Declaration

public AppendOptions Cas(ulong cas)

Parameters

Type	Name	Description
ulong	cas	A ulong value returned by the server in a previous operation.

Returns

Type	Description
AppendOptions	An options object for chaining.

Deconstruct(out ulong, out ReplicateTo, out PersistTo, out DurabilityLevel, out 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
ulong	cas
ReplicateTo	replicateTo
PersistTo	persistTo
DurabilityLevel	durabilityLevel
TimeSpan?	timeout
CancellationToken	token
IRetryStrategy	retryStrategy
IRequestSpan	requestSpan

Durability(DurabilityLevel)

The durability level required for persisting a JSON document across the cluster.

Declaration

public AppendOptions Durability(DurabilityLevel durabilityLevel)

Parameters

Type	Name	Description
DurabilityLevel	durabilityLevel	The Couchbase.KeyValue.AppendOptions.DurabilityLevel required for persistance.

Returns

Type	Description
AppendOptions	An options instance for chaining.

Durability(PersistTo, ReplicateTo)

The durability level required for persisting a JSON document across the cluster.

Declaration

public AppendOptions 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
AppendOptions	An options instance for chaining.

RequestSpan(IRequestSpan)

Inject an external span which will be the parent span of the internal span(s).

Declaration

public AppendOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
AppendOptions	An options instance for chaining.

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public AppendOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
AppendOptions	An options instance for chaining.

Timeout(TimeSpan)

The time in which the operation will timeout if it does not complete.

Declaration

public AppendOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout

Returns

Type	Description
AppendOptions	An options instance for chaining.