IndexingResult interface
單一檔的索引作業狀態。
屬性
error |
錯誤訊息,說明索引編制作業為何因索引鍵所識別的檔而失敗;如果索引成功,則為 null。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
key | 索引要求中檔索引鍵。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
status |
索引作業的狀態碼。 可能的值包括:200 代表成功更新或刪除、成功建立檔 201、400 表示格式不正確的輸入檔、找不到檔的 404、版本衝突的 409、當索引暫時無法使用時為 422,或當服務太忙碌時為 503。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
succeeded | 值,指出索引鍵所識別檔索引作業是否成功。 注意:此屬性不會序列化。 它只能由伺服器填入。 |
屬性詳細資料
errorMessage
錯誤訊息,說明索引編制作業為何因索引鍵所識別的檔而失敗;如果索引成功,則為 null。 注意:此屬性不會序列化。 它只能由伺服器填入。
errorMessage?: string
屬性值
string
key
索引要求中檔索引鍵。 注意:此屬性不會序列化。 它只能由伺服器填入。
key: string
屬性值
string
statusCode
索引作業的狀態碼。 可能的值包括:200 代表成功更新或刪除、成功建立檔 201、400 表示格式不正確的輸入檔、找不到檔的 404、版本衝突的 409、當索引暫時無法使用時為 422,或當服務太忙碌時為 503。 注意:此屬性不會序列化。 它只能由伺服器填入。
statusCode: number
屬性值
number
succeeded
值,指出索引鍵所識別檔索引作業是否成功。 注意:此屬性不會序列化。 它只能由伺服器填入。
succeeded: boolean
屬性值
boolean