Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class CollectionExistsOptions

Inheritance
object
CollectionExistsOptions
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 CollectionExistsOptions

Constructors

View Source

CollectionExistsOptions()

Declaration
public CollectionExistsOptions()

Properties

View Source

Default

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

DefaultReadOnly

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

Methods

View Source

AsReadOnly()

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

The Token to cancel the operation.

Returns
Type Description
CollectionExistsOptions

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

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

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

Returns
Type Description
CollectionExistsOptions

This class for method chaining.

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