Package version:

Interface IndexingResult

Status of an indexing operation for a single document.

interface IndexingResult {
    errorMessage?: string;
    key: string;
    statusCode: number;
    succeeded: boolean;
}

Properties

errorMessage? key statusCode succeeded

Properties

Optional ReadonlyerrorMessage

errorMessage?: string

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.

Readonlykey

key: string

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.

ReadonlystatusCode

statusCode: number

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.

Readonlysucceeded

succeeded: boolean

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.

Settings

Member Visibility