Class GetOptions
Assembly: Couchbase.NetClient.dll
Syntax
public class GetOptions : object, ITranscoderOverrideOptions, ITimeoutOptions, IKeyValueOptions
Fields
|
Improve this Doc
View Source
DefaultReadOnly
Declaration
public static readonly GetOptions.ReadOnly DefaultReadOnly
Field Value
Methods
|
Improve this Doc
View Source
AsReadOnly()
Declaration
public GetOptions.ReadOnly AsReadOnly()
Returns
|
Improve this Doc
View Source
CancellationToken(CancellationToken)
Declaration
public GetOptions CancellationToken(CancellationToken token)
Parameters
Type |
Name |
Description |
CancellationToken |
token |
|
Returns
|
Improve this Doc
View Source
Deconstruct(out Boolean, out ReadOnlyCollection<String>, out Nullable<TimeSpan>, out CancellationToken, out ITypeTranscoder, out IRetryStrategy, out IRequestSpan, out Boolean)
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
|
Improve this Doc
View Source
Expiry()
The time for the key/value pair to exist on the server.
Declaration
public GetOptions Expiry()
Returns
|
Improve this Doc
View Source
Projection(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
|
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 GetOptions RequestSpan(IRequestSpan span)
Parameters
Returns
|
Improve this Doc
View Source
RetryStrategy(IRetryStrategy)
Declaration
public GetOptions RetryStrategy(IRetryStrategy retryStrategy)
Parameters
Returns
|
Improve this Doc
View Source
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
|
Improve this Doc
View Source
Transcoder(ITypeTranscoder)
Declaration
public GetOptions Transcoder(ITypeTranscoder transcoder)
Parameters
Returns