Class GetOptions

Optional parameters for GetAsync(string, GetOptions?)

Inheritance

object

GetOptions

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 GetOptions

Fields

DefaultReadOnly

Declaration

public static readonly GetOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
GetOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public GetOptions.ReadOnly AsReadOnly()

Returns

Type	Description
GetOptions.ReadOnly

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public GetOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

Deconstruct(out bool, out ReadOnlyCollection<string>, out TimeSpan?, out CancellationToken, out ITypeTranscoder?, out IRetryStrategy?, out IRequestSpan?, out bool)

Declaration

public void Deconstruct(out bool includeExpiry, out ReadOnlyCollection<string> projectList, out TimeSpan? timeout, out CancellationToken token, out ITypeTranscoder? transcoder, out IRetryStrategy? retryStrategy, out IRequestSpan? requestSpan, out bool preferReturn)

Parameters

Type	Name	Description
bool	includeExpiry
ReadOnlyCollection<string>	projectList
TimeSpan?	timeout
CancellationToken	token
ITypeTranscoder	transcoder
IRetryStrategy	retryStrategy
IRequestSpan	requestSpan
bool	preferReturn

Expiry()

The time for the key/value pair to exist on the server.

Declaration

public GetOptions Expiry()

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

Projection(params string[])

A list or array of fields to project - if called will switch to subdoc and only fetch the fields requested. If the number of fields is > 16, then it will perform a full-doc lookup instead.

Declaration

public GetOptions Projection(params string[] fields)

Parameters

Type	Name	Description
string[]	fields

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

RequestSpan(IRequestSpan)

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

Declaration

public GetOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public GetOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

Timeout(TimeSpan)

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

Declaration

public GetOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout

Returns

Type	Description
GetOptions	A GetOptions instance for chaining.

Transcoder(ITypeTranscoder?)

Inject a ITypeTranscoder other than the default JsonTranscoder.

Declaration

public GetOptions Transcoder(ITypeTranscoder? transcoder)

Parameters

Type	Name	Description
ITypeTranscoder	transcoder

Returns

Type	Description
GetOptions