Class TouchOptions

Inheritance

object

TouchOptions

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 TouchOptions

Constructors

TouchOptions()

Declaration

public TouchOptions()

Fields

DefaultReadOnly

Declaration

public static readonly TouchOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
TouchOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public TouchOptions.ReadOnly AsReadOnly()

Returns

Type	Description
TouchOptions.ReadOnly

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public TouchOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
TouchOptions	An options instance for chaining.

Deconstruct(out 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
TimeSpan?	timeout
CancellationToken	token
IRetryStrategy	retryStrategy
IRequestSpan	requestSpan

RequestSpan(IRequestSpan)

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

Declaration

public TouchOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
TouchOptions	An options instance for chaining.

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public TouchOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
TouchOptions	An options instance for chaining.

Timeout(TimeSpan)

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

Declaration

public TouchOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout

Returns

Type	Description
TouchOptions	An options instance for chaining.