SearchIndexClient.CreateOrUpdateIndex メソッド

定義

名前空間:

Azure.Search.Documents.Indexes

アセンブリ:

Azure.Search.Documents.dll

パッケージ:

Azure.Search.Documents v11.5.1

ソース:

SearchIndexClient.cs

新しい検索インデックスを作成するか、既存のインデックスを更新します。

public virtual Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex> CreateOrUpdateIndex (Azure.Search.Documents.Indexes.Models.SearchIndex index, bool allowIndexDowntime = false, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrUpdateIndex : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>
override this.CreateOrUpdateIndex : Azure.Search.Documents.Indexes.Models.SearchIndex * bool * bool * System.Threading.CancellationToken -> Azure.Response<Azure.Search.Documents.Indexes.Models.SearchIndex>

Public Overridable Function CreateOrUpdateIndex (index As SearchIndex, Optional allowIndexDowntime As Boolean = false, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchIndex)

パラメーター

index

SearchIndex

必須。 SearchIndex作成または更新する 。

allowIndexDowntime

Boolean

数秒間インデックスを一時的にオフラインにすることで、アナライザー、トークナイザー、トークン フィルター、または文字フィルターをインデックスに追加できるかどうかを示す省略可能な値。 既定値は false です。 これにより、インデックス作成とクエリが一時的に失敗します。 インデックスを更新すると、インデックスのパフォーマンスと書き込み可用性が数分にわたり損なわれる場合があります。インデックスが非常に大きい場合、その時間も長くなります。

onlyIfUnchanged

Boolean

True を指定すると、 RequestFailedException が現在の ETag サービス バージョンと一致しない場合は がスローされます。それ以外の場合は、現在のサービス バージョンが上書きされます。

cancellationToken

CancellationToken

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

戻り値

Response<SearchIndex>

Response<T>作成または更新された をSearchIndex含むサーバーの 。 これは、サービスがフィールドの種類やその他のプロパティに応じて既定値に設定されたフィールドを返すことがあるため、渡されたものとは若干異なる場合があります。

例外

ArgumentNullException

index が null の場合にスローされます。

RequestFailedException

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