ResetDocumentsOptions interface

パッケージ:

@azure/search-documents

ドキュメントのリセット操作のオプション。

Extends

OperationOptions

プロパティ

datasourceDocumentIds	リセットするデータソースドキュメント識別子
documentKeys	リセットするドキュメント キー
overwrite	false の場合、キーまたは ID が既存のキーまたは ID に追加されます。 true の場合、このペイロード内のキーまたは ID のみがキューに格納され、再取り込みされます。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
serializerOptions	シリアル化/シリアル化解除の動作をオーバーライドするオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

datasourceDocumentIds

リセットするデータソースドキュメント識別子

datasourceDocumentIds?: string[]

プロパティ値

string[]

documentKeys

リセットするドキュメント キー

documentKeys?: string[]

プロパティ値

string[]

overwrite

false の場合、キーまたは ID が既存のキーまたは ID に追加されます。 true の場合、このペイロード内のキーまたは ID のみがキューに格納され、再取り込みされます。

overwrite?: boolean

プロパティ値

boolean

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignal から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

OperationOptions.requestOptions から継承された

serializerOptions

シリアル化/シリアル化解除の動作をオーバーライドするオプション。

serializerOptions?: SerializerOptions

プロパティ値

SerializerOptions

OperationOptions.serializerOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptions から継承された