Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class DropScopeOptions

Inheritance
object
DropScopeOptions
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Couchbase.Management.Collections
Assembly: Couchbase.NetClient.dll
Syntax
public class DropScopeOptions

Constructors

View Source

DropScopeOptions()

Declaration
public DropScopeOptions()

Properties

View Source

Default

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

DefaultReadOnly

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

Methods

View Source

AsReadOnly()

Declaration
public DropScopeOptions.ReadOnly AsReadOnly()
Returns
Type Description
DropScopeOptions.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 DropScopeOptions CancellationToken(CancellationToken token)
Parameters
Type Name Description
CancellationToken token

The Token to cancel the operation.

Returns
Type Description
DropScopeOptions

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 DropScopeOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span

The custom IRequestSpan to use for this operation.

Returns
Type Description
DropScopeOptions

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 DropScopeOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

The duration of the Timeout. Set to 75s by default.

Returns
Type Description
DropScopeOptions

This class for method chaining.

  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.