SearchClient.IndexDocumentsAsync<T> メソッド

  • リファレンス

定義

名前空間:
Azure.Search.Documents
アセンブリ:
Azure.Search.Documents.dll
パッケージ:
Azure.Search.Documents v11.5.1
パッケージ:
Azure.Search.Documents v11.6.0-beta.4
ソース:
SearchClient.cs
ソース:
SearchClient.cs

アップロード、マージ、削除アクションのバッチを検索インデックスに送信します。 ドキュメントの追加、更新、または削除

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>> IndexDocumentsAsync<T> (Azure.Search.Documents.Models.IndexDocumentsBatch<T> batch, Azure.Search.Documents.IndexDocumentsOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member IndexDocumentsAsync : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
override this.IndexDocumentsAsync : Azure.Search.Documents.Models.IndexDocumentsBatch<'T> * Azure.Search.Documents.IndexDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.IndexDocumentsResult>>
Public Overridable Function IndexDocumentsAsync(Of T) (batch As IndexDocumentsBatch(Of T), Optional options As IndexDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IndexDocumentsResult))

型パラメーター

T

インデックス スキーマにマップされる .NET 型。 この型のインスタンスは、インデックスからドキュメントとして取得できます。

パラメーター

batch
IndexDocumentsBatch<T>

ドキュメント インデックス アクションのバッチ。

options
IndexDocumentsOptions

ドキュメントのインデックス作成動作を指定できるオプション。

cancellationToken
CancellationToken

操作を取り消す必要がある通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Task<Response<IndexDocumentsResult>>

アクションのバッチ内のすべてのアクションの操作の状態を含む応答。

例外

RequestFailedException

Search Service によってエラーが返されたときにスローされます。

注釈

IndexDocuments メソッドと IndexDocumentsAsync メソッドのジェネリック オーバーロードでは、型パラメーター T を使用した .NET 型への検索フィールド型のマッピングがサポートされています。型マッピングの詳細については、 を参照してください GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) 。

既定では、要求全体が失敗した場合にのみ例外がスローされます。 個々のエラーについては、コレクションで Results 説明します。 部分的な障害時にAggregateExceptionスローされる に個々RequestFailedExceptionの をラップする場合は、 を設定ThrowOnAnyErrorできます。

適用対象