SearchIndexerClient.ResetDocuments Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| ResetDocuments(String, RequestContent, Nullable<Boolean>, RequestContext) |
[Protocol Method] Resets specific documents in the datasource to be selectively re-ingested by the indexer.
|
| ResetDocuments(String, ResetDocumentOptions, Nullable<Boolean>, CancellationToken) |
Resets specific documents in the datasource to be selectively re-ingested by the indexer. |
ResetDocuments(String, RequestContent, Nullable<Boolean>, RequestContext)
- Source:
- SearchIndexerClient.cs
[Protocol Method] Resets specific documents in the datasource to be selectively re-ingested by the indexer.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response ResetDocuments(string indexerName, Azure.Core.RequestContent content, bool? overwrite = default, Azure.RequestContext context = default);abstract member ResetDocuments : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.ResetDocuments : string * Azure.Core.RequestContent * Nullable<bool> * Azure.RequestContext -> Azure.ResponsePublic Overridable Function ResetDocuments (indexerName As String, content As RequestContent, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As ResponseParameters
- indexerName
- String
The name of the indexer.
- content
- RequestContent
The content to send as the body of the request.
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.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
indexerName is null.
indexerName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
ResetDocuments(String, ResetDocumentOptions, Nullable<Boolean>, CancellationToken)
- Source:
- SearchIndexerClient.cs
Resets specific documents in the datasource to be selectively re-ingested by the indexer.
public virtual Azure.Response ResetDocuments(string indexerName, Azure.Search.Documents.Indexes.Models.ResetDocumentOptions keysOrIds = default, bool? overwrite = default, System.Threading.CancellationToken cancellationToken = default);abstract member ResetDocuments : string * Azure.Search.Documents.Indexes.Models.ResetDocumentOptions * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response
override this.ResetDocuments : string * Azure.Search.Documents.Indexes.Models.ResetDocumentOptions * Nullable<bool> * System.Threading.CancellationToken -> Azure.ResponsePublic Overridable Function ResetDocuments (indexerName As String, Optional keysOrIds As ResetDocumentOptions = Nothing, Optional overwrite As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ResponseParameters
- indexerName
- String
The name of the indexer.
- keysOrIds
- ResetDocumentOptions
The keys or ids of the documents to be re-ingested. If keys are provided, the document key field must be specified in the indexer configuration. If ids are provided, the document key field is ignored.
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.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
indexerName is null.
indexerName is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
