Class LookupInOptions

Inheritance

object

LookupInOptions

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 LookupInOptions

Constructors

LookupInOptions()

Declaration

public LookupInOptions()

Fields

DefaultReadOnly

Declaration

public static readonly LookupInOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
LookupInOptions.ReadOnly

Methods

AccessDeleted(bool)

Declaration

public LookupInOptions AccessDeleted(bool accessDeleted)

Parameters

Type	Name	Description
bool	accessDeleted

Returns

Type	Description
LookupInOptions

AsReadOnly()

Declaration

public LookupInOptions.ReadOnly AsReadOnly()

Returns

Type	Description
LookupInOptions.ReadOnly

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public LookupInOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
LookupInOptions	An options instance for chaining.

Deconstruct(out TimeSpan?, out CancellationToken, out bool, out ITypeSerializer?, out ITypeTranscoder?, out bool, out IRetryStrategy?, out IRequestSpan?, out bool, out InternalReadPreference)

Declaration

public void Deconstruct(out TimeSpan? timeout, out CancellationToken token, out bool expiry, out ITypeSerializer? serializer, out ITypeTranscoder? transcoder, out bool accessDeleted, out IRetryStrategy? retryStrategy, out IRequestSpan? requestSpan, out bool preferReturn, out InternalReadPreference readPreference)

Parameters

Type	Name	Description
TimeSpan?	timeout
CancellationToken	token
bool	expiry
ITypeSerializer	serializer
ITypeTranscoder	transcoder
bool	accessDeleted
IRetryStrategy	retryStrategy
IRequestSpan	requestSpan
bool	preferReturn
InternalReadPreference	readPreference

Expiry(bool)

Sets the expiration for a document. By default, documents never expire - if overridden the value must be less than 50 years.

Declaration

public LookupInOptions Expiry(bool expiry)

Parameters

Type	Name	Description
bool	expiry	The time-to-live of the document.

Returns

Type	Description
LookupInOptions	An options object for chaining.

RequestSpan(IRequestSpan)

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

Declaration

public LookupInOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
LookupInOptions	An options instance for chaining.

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public LookupInOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
LookupInOptions	An options instance for chaining.

Serializer(ITypeSerializer?)

A custom ITypeSerializer implementation for serialization.

Declaration

public LookupInOptions Serializer(ITypeSerializer? serializer)

Parameters

Type	Name	Description
ITypeSerializer	serializer	A custom ITypeSerializer implementation for serialization.

Returns

Type	Description
LookupInOptions	An options instance for chaining.

Timeout(TimeSpan?)

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

Declaration

public LookupInOptions Timeout(TimeSpan? timeout)

Parameters

Type	Name	Description
TimeSpan?	timeout

Returns

Type	Description
LookupInOptions	An options instance for chaining.

Transcoder(ITypeTranscoder?)

Only used internally for full doc gets which also need the expiry. Should not be used for JSON-based LookupIn ops. Not exposed for public consumption.

Declaration

public LookupInOptions Transcoder(ITypeTranscoder? transcoder)

Parameters

Type	Name	Description
ITypeTranscoder	transcoder

Returns

Type	Description
LookupInOptions