Class GetSearchIndexOptions

Inheritance

object

GetSearchIndexOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Management.Search

Assembly: Couchbase.NetClient.dll

Syntax

public class GetSearchIndexOptions

Fields

| Edit this page View Source

DefaultReadOnly

Declaration

public static readonly GetSearchIndexOptions.ReadOnly DefaultReadOnly

Field Value

Type	Description
GetSearchIndexOptions.ReadOnly

Properties

| Edit this page View Source

Default

Declaration

public static GetSearchIndexOptions Default { get; }

Property Value

Type	Description
GetSearchIndexOptions

Methods

| Edit this page View Source

AsReadOnly()

Declaration

public GetSearchIndexOptions.ReadOnly AsReadOnly()

Returns

Type	Description
GetSearchIndexOptions.ReadOnly

| Edit this page 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 GetSearchIndexOptions CancellationToken(CancellationToken cancellationToken)

Parameters

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

Returns

Type	Description
GetSearchIndexOptions	This class for method chaining.

| Edit this page 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

| Edit this page 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 GetSearchIndexOptions Timeout(TimeSpan timeout)

Parameters

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

Returns

Type	Description
GetSearchIndexOptions	This class for method chaining.