SearchIndexerClient.ResetDocumentsAsync Method

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
SearchIndexerClient.cs

Resets specific documents in the datasource to be selectively re-ingested by the indexer.

public virtual System.Threading.Tasks.Task<Azure.Response> ResetDocumentsAsync (string indexerName, bool? overwrite = default, Azure.Search.Documents.Models.ResetDocumentOptions resetDocumentOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ResetDocumentsAsync : string * Nullable<bool> * Azure.Search.Documents.Models.ResetDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.ResetDocumentsAsync : string * Nullable<bool> * Azure.Search.Documents.Models.ResetDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function ResetDocumentsAsync (indexerName As String, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional resetDocumentOptions As ResetDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

indexerName
String

The name of the indexer to reset documents for.

overwrite
Nullable<Boolean>

If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested.

resetDocumentOptions
ResetDocumentOptions

The reset options to use.

cancellationToken
CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Task<Response>

A Task<TResult> representing the result of the asynchronous operation.

Applies to