IndexingResult interface

Stan operacji indeksowania dla pojedynczego dokumentu.

Właściwości

errorMessage

Komunikat o błędzie wyjaśniający, dlaczego operacja indeksowania nie powiodła się dla dokumentu zidentyfikowanego przez klucz; null, jeśli indeksowanie zakończyło się pomyślnie.

key

Klucz dokumentu, który był w żądaniu indeksowania.

statusCode

Kod stanu operacji indeksowania. Możliwe wartości to: 200 dla pomyślnej aktualizacji lub usunięcia, 201 w przypadku pomyślnego utworzenia dokumentu, 400 dla źle sformułowanego dokumentu wejściowego, 404 dla nie odnalezionego dokumentu, 409 w przypadku konfliktu wersji, 422, gdy indeks jest tymczasowo niedostępny lub 503, gdy usługa jest zbyt zajęta.

succeeded

Wartość wskazująca, czy operacja indeksowania zakończyła się pomyślnie dla dokumentu zidentyfikowanego przez klucz.

Szczegóły właściwości

errorMessage

Komunikat o błędzie wyjaśniający, dlaczego operacja indeksowania nie powiodła się dla dokumentu zidentyfikowanego przez klucz; null, jeśli indeksowanie zakończyło się pomyślnie.

errorMessage?: string

Wartość właściwości

string

key

Klucz dokumentu, który był w żądaniu indeksowania.

key: string

Wartość właściwości

string

statusCode

Kod stanu operacji indeksowania. Możliwe wartości to: 200 dla pomyślnej aktualizacji lub usunięcia, 201 w przypadku pomyślnego utworzenia dokumentu, 400 dla źle sformułowanego dokumentu wejściowego, 404 dla nie odnalezionego dokumentu, 409 w przypadku konfliktu wersji, 422, gdy indeks jest tymczasowo niedostępny lub 503, gdy usługa jest zbyt zajęta.

statusCode: number

Wartość właściwości

number

succeeded

Wartość wskazująca, czy operacja indeksowania zakończyła się pomyślnie dla dokumentu zidentyfikowanego przez klucz.

succeeded: boolean

Wartość właściwości

boolean