Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class GetAllSearchIndexesOptions

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

Constructors

View Source

GetAllSearchIndexesOptions()

Declaration
public GetAllSearchIndexesOptions()

Fields

View Source

DefaultReadOnly

Declaration
public static readonly GetAllSearchIndexesOptions.ReadOnly DefaultReadOnly
Field Value
Type Description
GetAllSearchIndexesOptions.ReadOnly

Properties

View Source

Default

Declaration
public static GetAllSearchIndexesOptions Default { get; }
Property Value
Type Description
GetAllSearchIndexesOptions

Methods

View Source

AsReadOnly()

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

The Token to cancel the operation.

Returns
Type Description
GetAllSearchIndexesOptions

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)

Declaration
public GetAllSearchIndexesOptions RequestSpan(IRequestSpan span)
Parameters
Type Name Description
IRequestSpan span
Returns
Type Description
GetAllSearchIndexesOptions
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 GetAllSearchIndexesOptions Timeout(TimeSpan timeout)
Parameters
Type Name Description
TimeSpan timeout

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

Returns
Type Description
GetAllSearchIndexesOptions

This class for method chaining.

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