Class: Enactor::Status

Inherits:
Object
  • Object
show all
Defined in:
lib/enactor/client.rb

Overview

Status messages that can be returned from TavernaService.get_job_status().

If finished?(status) is true, this means the job is finished, either successfully (COMPLETE), unsuccessfully (CANCELLED, FAILED), or that the job is no longer in the database (DESTROYED).

When a job has just been created it will be in status NEW, after that it will immediately be on a queue and in the state QUEUED. Once the job has been picked up by a worker it will be in INITIALISING, this state might include the startup time of the worker and while downloading the workflow and input data to the worker. The state PAUSED is not currently used. The FAILING state can occur if the workflow engine crashed, after clean-up or if the workflow itself failed, the state will be FAILED.

The job might at any time be set to the state CANCELLING by the user, which will stop execution of the workflow, leading to the state CANCELLED.

If the workflow execution completed the state will be set to COMPLETE, after which the workflow result data should be available by using get_job_outputs_doc().

If data about the job has been lost (probably because it’s too old or has been deleted by the user), the state will be DESTROYED.

Constant Summary collapse

NEW = 
"NEW"
QUEUED = 
"QUEUED"
INITIALISING = 
"INITIALISING"
PAUSED = 
"PAUSED"
FAILING = 
"FAILING"
CANCELLING = 
"CANCELLING"
CANCELLED = 
"CANCELLED"
COMPLETE = 
"COMPLETE"
FAILED = 
"FAILED"
DESTROYED = 
"DESTROYED"
FINISHED = 
[COMPLETE, CANCELLED, DESTROYED, FAILED]
ALL = 
[NEW, QUEUED, INITIALISING, FAILING, 
CANCELLING, CANCELLED, COMPLETE, FAILED, DESTROYED]

Class Method Summary collapse

Class Method Details

.finished?(status) ⇒ Boolean

Return True if the status is a finished status.

This would normally include COMPLETE, CANCELLED, DESTROYED and FAILED.

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/enactor/client.rb', line 76

def Status.finished?(status)
    return FINISHED.include?(status)
end

.valid?(status) ⇒ Boolean

Check if a string is a valid status.

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/enactor/client.rb', line 81

def Status.valid?(status)
    ALL.include?(status)
end