IndexingResult interface

  • Reference
Package:
@azure/search-documents

Status of an indexing operation for a single document.

Properties

errorMessage

The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. NOTE: This property will not be serialized. It can only be populated by the server.
key

The key of a document that was in the indexing request. NOTE: This property will not be serialized. It can only be populated by the server.
statusCode

The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. NOTE: This property will not be serialized. It can only be populated by the server.
succeeded

A value indicating whether the indexing operation succeeded for the document identified by the key. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

errorMessage

The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. NOTE: This property will not be serialized. It can only be populated by the server.

errorMessage?: string

Property Value

string

key

The key of a document that was in the indexing request. NOTE: This property will not be serialized. It can only be populated by the server.

key: string

Property Value

string

statusCode

The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. NOTE: This property will not be serialized. It can only be populated by the server.

statusCode: number

Property Value

number

succeeded

A value indicating whether the indexing operation succeeded for the document identified by the key. NOTE: This property will not be serialized. It can only be populated by the server.

succeeded: boolean

Property Value

boolean