OCRUploadedFileState

View as Markdown

The state of an OCR job of a stateless upload (OCRUploadedFile).

Full name	`MFiles.OCRUploadedFileState`
Proto file	`mfiles/enums.proto`

Values

Name	Number	Description
`OCRUPLOADED_FILE_STATE_UNSPECIFIED`	0	Not specified.
`OCRUPLOADED_FILE_STATE_QUEUED`	1	The job is waiting for a server to process it.
`OCRUPLOADED_FILE_STATE_RUNNING`	2	A server is processing the job.
`OCRUPLOADED_FILE_STATE_COMPLETED`	3	The job has completed. The result is available as a file_ref.
`OCRUPLOADED_FILE_STATE_FAILED`	4	The job has failed. The error is available.
`OCRUPLOADED_FILE_STATE_CANCELED`	5	The job has been canceled.

Used by methods

IRPCScanningAndOCR.GetOCRUploadedFileStatus -- Gets the state of an OCR job started with OCRUploadedFile and, when it has completed, its result as a file_ref. Optionally requests the cancellation of the job.

Used in fields

GetOCRUploadedFileStatusResponse.state -- The state of the job.