Class LookupInOptions

Inheritance

LookupInOptions

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class LookupInOptions : object, ITimeoutOptions, ITranscoderOverrideOptions, IKeyValueOptions

Fields

| Improve this Doc View Source

DefaultReadOnly

Declaration

public static readonly LookupInOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
LookupInOptions.ReadOnly

Methods

| Improve this Doc View Source

AccessDeleted(Boolean)

Declaration

public LookupInOptions AccessDeleted(bool accessDeleted)

Parameters

Type	Name	Description
Boolean	accessDeleted

Returns

Type	Description
LookupInOptions

| Improve this Doc View Source

AsReadOnly()

Declaration

public LookupInOptions.ReadOnly AsReadOnly()

Returns

Type	Description
LookupInOptions.ReadOnly

| Improve this Doc View Source

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.

| Improve this Doc View Source

Deconstruct(out Nullable<TimeSpan>, out CancellationToken, out Boolean, out ITypeSerializer, out ITypeTranscoder, out Boolean, out IRetryStrategy, out IRequestSpan)

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)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeout
CancellationToken	token
Boolean	expiry
ITypeSerializer	serializer
ITypeTranscoder	transcoder
Boolean	accessDeleted
IRetryStrategy	retryStrategy
IRequestSpan	requestSpan

| Improve this Doc View Source

Expiry(Boolean)

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
Boolean	expiry	The time-to-live of the document.

Returns

Type	Description
LookupInOptions	An options object for chaining.

| Improve this Doc View Source

RequestSpan(IRequestSpan)

Inject an external span which will the 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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

Timeout(Nullable<TimeSpan>)

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

Declaration

public LookupInOptions Timeout(TimeSpan? timeout)

Parameters

Type	Name	Description
Nullable<TimeSpan>	timeout

Returns

Type	Description
LookupInOptions	An options instance for chaining.

| Improve this Doc View Source

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