IndexingResult interface
Status of an indexing operation for a single document.
Properties
| error |
The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. |
| key | The key of a document that was in the indexing request. |
| status |
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. |
| succeeded | A value indicating whether the indexing operation succeeded for the document identified by the key. |
Property Details
errorMessage
The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.
errorMessage?: stringProperty Value
string
key
The key of a document that was in the indexing request.
key: stringProperty 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.
statusCode: numberProperty Value
number
succeeded
A value indicating whether the indexing operation succeeded for the document identified by the key.
succeeded: booleanProperty Value
boolean