IndexingResult interface

パッケージ:

@azure/search-documents

1 つのドキュメントのインデックス作成操作の状態。

プロパティ

errorMessage	キーで識別されたドキュメントのインデックス作成操作が失敗した理由を説明するエラー メッセージ。インデックス作成に成功した場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
key	インデックス作成要求にあったドキュメントのキー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
statusCode	インデックス作成操作の状態コード。 使用できる値は、更新または削除が成功した場合は 200、ドキュメントの作成が成功した場合は 201、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 です。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
succeeded	キーで識別されたドキュメントに対してインデックス作成操作が成功したかどうかを示す値。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

errorMessage

キーで識別されたドキュメントのインデックス作成操作が失敗した理由を説明するエラー メッセージ。インデックス作成に成功した場合は null。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

errorMessage?: string

プロパティ値

string

key

インデックス作成要求にあったドキュメントのキー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

key: string

プロパティ値

string

statusCode

インデックス作成操作の状態コード。 使用できる値は、更新または削除が成功した場合は 200、ドキュメントの作成が成功した場合は 201、形式が正しくない入力ドキュメントの場合は 400、ドキュメントが見つからない場合は 404、バージョンの競合の場合は 409、インデックスが一時的に使用できない場合は 422、サービスがビジー状態の場合は 503 です。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

statusCode: number

プロパティ値

number

succeeded

キーで識別されたドキュメントに対してインデックス作成操作が成功したかどうかを示す値。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

succeeded: boolean

プロパティ値

boolean