Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 4.97 KB

Task.md

File metadata and controls

25 lines (22 loc) · 4.97 KB

IronWorker::Task

Properties

Name Type Description Notes
image String Name of Docker image to use. This is optional and can be used to override the image defined at the group level.
payload String Payload for the task. This is what you pass into each task to make it do something. [optional]
delay Integer Number of seconds to wait before queueing the task for consumption for the first time. Must be a positive integer. Tasks with a delay start in state "delayed" and transition to "running" after delay seconds. [optional] [default to 0]
timeout Integer Maximum runtime in seconds. If a consumer retrieves the task, but does not change it's status within timeout seconds, the task is considered failed, with reason timeout (Titan may allow a small grace period). The consumer should also kill the task after timeout seconds. If a consumer tries to change status after Titan has already timed out the task, the consumer will be ignored. [optional] [default to 60]
priority Integer Priority of the task. Higher has more priority. 3 levels from 0-2. Tasks at same priority are processed in FIFO order.
max_retries Integer "Number of automatic retries this task is allowed. A retry will be attempted if a task fails. Max 25. Automatic retries are performed by titan when a task reaches a failed state and has `max_retries` > 0. A retry is performed by queueing a new task with the same image id and payload. The new task's max_retries is one less than the original. The new task's `retry_of` field is set to the original Task ID. The old task's `retry_at` field is set to the new Task's ID. Titan will delay the new task for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried." [optional] [default to 0]
retries_delay Integer Time in seconds to wait before retrying the task. Must be a non-negative integer. [optional] [default to 60]
id String Unique identifier representing a specific task. [optional]
status String States and valid transitions. +---------+ +---------> delayed <----------------+ +----+----+
group_name String Group this task belongs to. [optional]
error String The error message, if status is 'error'. This is errors due to things outside the task itself. Errors from user code will be found in the log. [optional]
reason String Machine usable reason for task being in this state. Valid values for error status are `timeout killed
created_at DateTime Time when task was submitted. Always in UTC. [optional]
started_at DateTime Time when task started execution. Always in UTC. [optional]
completed_at DateTime Time when task completed, whether it was successul or failed. Always in UTC. [optional]
retry_of String If this field is set, then this task is a retry of the ID in this field. [optional]
retry_at String If this field is set, then this task was retried by the task referenced in this field. [optional]
env_vars Hash<String, String> Env vars for the task. Comes from the ones set on the Group. [optional]