Class SearchIndexManagerExtensions

Inheritance

object

SearchIndexManagerExtensions

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 static class SearchIndexManagerExtensions

Methods

| Edit this page View Source

AllowQueryingAsync(ISearchIndexManager, string)

Declaration

public static Task AllowQueryingAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

AllowQueryingAsync(ISearchIndexManager, string, Action<AllowQueryingSearchIndexOptions>)

Declaration

public static Task AllowQueryingAsync(this ISearchIndexManager manager, string indexName, Action<AllowQueryingSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<AllowQueryingSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

DisallowQueryingAsync(ISearchIndexManager, string)

Declaration

public static Task DisallowQueryingAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

DisallowQueryingAsync(ISearchIndexManager, string, Action<DisallowQueryingSearchIndexOptions>)

Declaration

public static Task DisallowQueryingAsync(this ISearchIndexManager manager, string indexName, Action<DisallowQueryingSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<DisallowQueryingSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

DropIndexAsync(ISearchIndexManager, string)

Declaration

public static Task DropIndexAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

DropIndexAsync(ISearchIndexManager, string, Action<DropSearchIndexOptions>)

Declaration

public static Task DropIndexAsync(this ISearchIndexManager manager, string indexName, Action<DropSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<DropSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

FreezePlanAsync(ISearchIndexManager, string)

Declaration

public static Task FreezePlanAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

FreezePlanAsync(ISearchIndexManager, string, Action<FreezePlanSearchIndexOptions>)

Declaration

public static Task FreezePlanAsync(this ISearchIndexManager manager, string indexName, Action<FreezePlanSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<FreezePlanSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

GetAllIndexesAsync(ISearchIndexManager)

Declaration

public static Task<IEnumerable<SearchIndex>> GetAllIndexesAsync(this ISearchIndexManager manager)

Parameters

Type	Name	Description
ISearchIndexManager	manager

Returns

Type	Description
Task<IEnumerable<SearchIndex>>

| Edit this page View Source

GetAllIndexesAsync(ISearchIndexManager, Action<GetAllSearchIndexesOptions>)

Declaration

public static Task<IEnumerable<SearchIndex>> GetAllIndexesAsync(this ISearchIndexManager manager, Action<GetAllSearchIndexesOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
Action<GetAllSearchIndexesOptions>	configureOptions

Returns

Type	Description
Task<IEnumerable<SearchIndex>>

| Edit this page View Source

GetIndexAsync(ISearchIndexManager, string)

Declaration

public static Task<SearchIndex> GetIndexAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task<SearchIndex>

| Edit this page View Source

GetIndexAsync(ISearchIndexManager, string, Action<GetSearchIndexOptions>)

Declaration

public static Task<SearchIndex> GetIndexAsync(this ISearchIndexManager manager, string indexName, Action<GetSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<GetSearchIndexOptions>	configureOptions

Returns

Type	Description
Task<SearchIndex>

| Edit this page View Source

GetIndexedDocumentsCountAsync(ISearchIndexManager, string)

Declaration

public static Task<int> GetIndexedDocumentsCountAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task<int>

| Edit this page View Source

GetIndexedDocumentsCountAsync(ISearchIndexManager, string, Action<GetSearchIndexDocumentCountOptions>)

Declaration

public static Task<int> GetIndexedDocumentsCountAsync(this ISearchIndexManager manager, string indexName, Action<GetSearchIndexDocumentCountOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<GetSearchIndexDocumentCountOptions>	configureOptions

Returns

Type	Description
Task<int>

| Edit this page View Source

PauseIngestAsync(ISearchIndexManager, string)

Declaration

public static Task PauseIngestAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

PauseIngestAsync(ISearchIndexManager, string, Action<PauseIngestSearchIndexOptions>)

Declaration

public static Task PauseIngestAsync(this ISearchIndexManager manager, string indexName, Action<PauseIngestSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<PauseIngestSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

ResumeIngestAsync(ISearchIndexManager, string)

Declaration

public static Task ResumeIngestAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

ResumeIngestAsync(ISearchIndexManager, string, Action<ResumeIngestSearchIndexOptions>)

Declaration

public static Task ResumeIngestAsync(this ISearchIndexManager manager, string indexName, Action<ResumeIngestSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<ResumeIngestSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

UnfreezePlanAsync(ISearchIndexManager, string)

Declaration

public static Task UnfreezePlanAsync(this ISearchIndexManager manager, string indexName)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName

Returns

Type	Description
Task

| Edit this page View Source

UnfreezePlanAsync(ISearchIndexManager, string, Action<UnfreezePlanSearchIndexOptions>)

Declaration

public static Task UnfreezePlanAsync(this ISearchIndexManager manager, string indexName, Action<UnfreezePlanSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
string	indexName
Action<UnfreezePlanSearchIndexOptions>	configureOptions

Returns

Type	Description
Task

| Edit this page View Source

UpsertIndexAsync(ISearchIndexManager, SearchIndex)

Declaration

public static Task UpsertIndexAsync(this ISearchIndexManager manager, SearchIndex indexDefinition)

Parameters

Type	Name	Description
ISearchIndexManager	manager
SearchIndex	indexDefinition

Returns

Type	Description
Task

| Edit this page View Source

UpsertIndexAsync(ISearchIndexManager, SearchIndex, Action<UpsertSearchIndexOptions>)

Declaration

public static Task UpsertIndexAsync(this ISearchIndexManager manager, SearchIndex indexDefinition, Action<UpsertSearchIndexOptions> configureOptions)

Parameters

Type	Name	Description
ISearchIndexManager	manager
SearchIndex	indexDefinition
Action<UpsertSearchIndexOptions>	configureOptions

Returns

Type	Description
Task