Class CreateScopeOptions

Inheritance

System.Object

CreateScopeOptions

Namespace: Couchbase.Management.Collections

Assembly: Couchbase.NetClient.dll

Syntax

public class CreateScopeOptions : object

Properties

Default

Declaration

public static CreateScopeOptions Default { get; }

Property Value

Type	Description
CreateScopeOptions

DefaultReadOnly

Declaration

public static CreateScopeOptions.ReadOnly DefaultReadOnly { get; }

Property Value

Type	Description
CreateScopeOptions.ReadOnly

Methods

AsReadOnly()

Declaration

public CreateScopeOptions.ReadOnly AsReadOnly()

Returns

Type	Description
CreateScopeOptions.ReadOnly

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 CreateScopeOptions CancellationToken(CancellationToken token)

Parameters

Type	Name	Description
CancellationToken	token	The Token to cancel the operation.

Returns

Type	Description
CreateScopeOptions	This class for method chaining.

Deconstruct(out CancellationToken, out TimeSpan)

Declaration

public void Deconstruct(out CancellationToken tokenValue, out TimeSpan timeoutValue)

Parameters

Type	Name	Description
CancellationToken	tokenValue
TimeSpan	timeoutValue

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 CreateScopeOptions Timeout(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	The duration of the Timeout. Set to 75s by default.

Returns

Type	Description
CreateScopeOptions	This class for method chaining.