Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ItemError

Package version

Represents an item- or document-level indexing error.

Hierarchy

  • ItemError

Index

Properties

Optional details

details: undefined | string

Additional, verbose details about the error to assist in debugging the indexer. This may not be always available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional documentationLink

documentationLink: undefined | string

A link to a troubleshooting guide for these classes of errors. This may not be always available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorMessage

errorMessage: undefined | string

The message describing the error that occurred while processing the item. NOTE: This property will not be serialized. It can only be populated by the server.

Optional key

key: undefined | string

The key of the item for which indexing failed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available. NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusCode

statusCode: undefined | number

The status code indicating why the indexing operation failed. Possible values include: 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.

Generated using TypeDoc