Class UpdateCollectionOptions

Inheritance
object
UpdateCollectionOptions
Inherited Members
Namespace: Couchbase.Management.Collections
Assembly: Couchbase.NetClient.dll
Syntax
public class UpdateCollectionOptions

Constructors

View Source

UpdateCollectionOptions()

Declaration
public UpdateCollectionOptions()

Properties

View Source

Default

Declaration
public static UpdateCollectionOptions Default { get; }
Property Value
Type Description
UpdateCollectionOptions
View Source

DefaultReadOnly

Declaration
public static UpdateCollectionOptions.ReadOnly DefaultReadOnly { get; }
Property Value
Type Description
UpdateCollectionOptions.ReadOnly

Methods

View Source

AsReadOnly()

Declaration
public UpdateCollectionOptions.ReadOnly AsReadOnly()
Returns
Type Description
UpdateCollectionOptions.ReadOnly
View Source

CancellationToken(CancellationToken)

Allows to pass in a custom CancellationToken from a CancellationTokenSource. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public UpdateCollectionOptions CancellationToken(CancellationToken token)
Parameters
Type Name Description
CancellationToken token

The Token to cancel the operation.
Returns
Type Description
UpdateCollectionOptions

This class for method chaining.
View Source

Deconstruct(out CancellationToken, out TimeSpan)

Declaration
public void Deconstruct(out CancellationToken tokenValue, out TimeSpan timeoutValue)
Parameters
Type Name Description
CancellationToken tokenValue
TimeSpan timeoutValue
View Source

RequestSpan(IRequestSpan)

Allows to pass in a custom IRequestSpan

Declaration
public UpdateCollectionOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span

The custom IRequestSpan to use for this operation.
Returns
Type Description
UpdateCollectionOptions

This class for method chaining.
View Source

Timeout(TimeSpan)

Allows to set a Timeout for the operation. Note that CancellationToken() takes precedence over Timeout(). If both CancellationToken and Timeout are set, the former will be used in the operation.

Declaration
public UpdateCollectionOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

The duration of the Timeout. Set to 75s by default.
Returns
Type Description
UpdateCollectionOptions

This class for method chaining.