class Abbyy::Models::Task
- Abbyy::Models::Task
- Abbyy::Models::BaseModel
- Reference
- Object
Overview
Task.
See status-codes
Defined in:
abbyy/models/task.crConstant Summary
-
TIME_FORMAT =
"%Y-%m-%dT%H:%M:%SZ"
Constructors
Instance Method Summary
-
#credits : Int32 | Nil
Specifies the cost of processing: it contains the estimated cost before task processing, and the actual cost, after the task has been completed.
-
#credits=(credits : Int32 | Nil)
Specifies the cost of processing: it contains the estimated cost before task processing, and the actual cost, after the task has been completed.
- #description : String | Nil
- #description=(description : String | Nil)
-
#error : String | Nil
Description of the error occurred during processing.
-
#error=(error : String | Nil)
Description of the error occurred during processing.
-
#estimated_processing_time : Int32 | Nil
Estimated time until the task is completed (in seconds).
-
#estimated_processing_time=(estimated_processing_time : Int32 | Nil)
Estimated time until the task is completed (in seconds).
-
#files_count : Int32 | Nil
Specifies the number of files in the task.
-
#files_count=(files_count : Int32 | Nil)
Specifies the number of files in the task.
-
#id : String | Nil
Specifies the identifier of the task.
-
#id=(id : String | Nil)
Specifies the identifier of the task.
- #registration_time : Time | Nil
- #registration_time=(registration_time : Time | Nil)
-
#result_url : String | Nil
This attribute is only available for completed tasks.
-
#result_url2 : String | Nil
This attribute is only available for completed tasks which were processed with multiple export formats.
-
#result_url2=(result_url2 : String | Nil)
This attribute is only available for completed tasks which were processed with multiple export formats.
-
#result_url3 : String | Nil
This attribute is only available for completed tasks which were processed with three export formats.
-
#result_url3=(result_url3 : String | Nil)
This attribute is only available for completed tasks which were processed with three export formats.
-
#result_url=(result_url : String | Nil)
This attribute is only available for completed tasks.
- #status : TaskStatus | Nil
- #status=(status : TaskStatus | Nil)
- #status_change_time : Time | Nil
- #status_change_time=(status_change_time : Time | Nil)
Constructor Detail
Instance Method Detail
Specifies the cost of processing: it contains the estimated cost before task processing, and the actual cost, after the task has been completed. The measurement unit is the price of processing of one field.
Specifies the cost of processing: it contains the estimated cost before task processing, and the actual cost, after the task has been completed. The measurement unit is the price of processing of one field.
Description of the error occurred during processing.
This attribute is available for the tasks with ProcessingFailed status only.
Description of the error occurred during processing.
This attribute is available for the tasks with ProcessingFailed status only.
Estimated time until the task is completed (in seconds).
This attribute is available for the tasks with Queued or InProgress status.
Estimated time until the task is completed (in seconds).
This attribute is available for the tasks with Queued or InProgress status.
This attribute is only available for completed tasks. It provides the URL of the result of processing. The hyperlink has limited lifetime. If you want to download the result after that time has passed, use the getTaskStatus or listTasks method to obtain the new hyperlink.
This attribute is only available for completed tasks which were processed with multiple export formats. It provides the URL of the result saved in the second specified format. Otherwise, it has the same properties as the resultUrl attribute.
This attribute is only available for completed tasks which were processed with multiple export formats. It provides the URL of the result saved in the second specified format. Otherwise, it has the same properties as the resultUrl attribute.
This attribute is only available for completed tasks which were processed with three export formats. It provides the URL of the result saved in the third specified format. Otherwise, it has the same properties as the resultUrl attribute.
This attribute is only available for completed tasks which were processed with three export formats. It provides the URL of the result saved in the third specified format. Otherwise, it has the same properties as the resultUrl attribute.
This attribute is only available for completed tasks. It provides the URL of the result of processing. The hyperlink has limited lifetime. If you want to download the result after that time has passed, use the getTaskStatus or listTasks method to obtain the new hyperlink.