Class ExistsOptions

Optional parameters for ExistsAsync(String, ExistsOptions)

Inheritance

ExistsOptions

Namespace: Couchbase.KeyValue

Assembly: Couchbase.NetClient.dll

Syntax

public class ExistsOptions : object, ITimeoutOptions, IKeyValueOptions

Fields

| Improve this Doc View Source

DefaultReadOnly

Declaration

public static readonly ExistsOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
ExistsOptions.ReadOnly

Methods

| Improve this Doc View Source

AsReadOnly()

Declaration

public ExistsOptions.ReadOnly AsReadOnly()

Returns

Type	Description
ExistsOptions.ReadOnly

| Improve this Doc View Source

CancellationToken(CancellationToken)

A CancellationToken(CancellationToken) for cooperative cancellation.

Declaration

public ExistsOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token

Returns

Type	Description
ExistsOptions	An options instance for chaining.

| Improve this Doc View Source

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

| 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 ExistsOptions RequestSpan(IRequestSpan span)

Parameters

Type	Name	Description
IRequestSpan	span	An IRequestSpan

Returns

Type	Description
ExistsOptions	A ExistsOptions instance for chaining.

| Improve this Doc View Source

RetryStrategy(IRetryStrategy)

Inject a custom IRetryStrategy.

Declaration

public ExistsOptions RetryStrategy(IRetryStrategy retryStrategy)

Parameters

Type	Name	Description
IRetryStrategy	retryStrategy

Returns

Type	Description
ExistsOptions	An options instance for chaining.

| Improve this Doc View Source

Timeout(TimeSpan)

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

Declaration

public ExistsOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout

Returns

Type	Description
ExistsOptions	An options instance for chaining.