IronWorker Glossary
Table of Contents
Body - The data of the message being pushed or pulled
API Version - The IronWorker API version is 2
Cancelled - This is the task status when cancelled by the user
CLI - The Iron.io commandline Interface tool written in Go. More information can be found here
Cluster - This option is for users with their own custom worker cluster. If it omitted, the default cluster will be used
code_name - This option is used when scheduling a task. The code name is assigned during the code upload
Code Package - The code that will run when your worker runs
Command - The command to execute when running your worker code
Complete - This is the task status when the task has finished
Config - An arbitrary string (usually YAML or JSON) that, if provided, will be available in a file that your worker can access
Content-Length - When uploading or updating a code package, the request needs this added to the header. It is used for the number of bytes in your JSON-encoded request body
Content-Type - When uploading or updating a code package, the request needs this added to the header. It should be set to "multipart/form-data ; boundary={Insert Value Here}" with boundary set to an appropriate value
default_priority - The default priority of the tasks running this code. Valid values are 0, 1, and 2. The priority of the task can be set when queueing the task. If it's not set when queueing the task, the default priority is used
delay - The number of seconds to delay before actually queuing the task. Default is 0. Maximum is 604,800 seconds (7 days)
end_at - Used when scheduling a task, this is the time tasks will stop being queued. Should be a time or datetime
end_date - When getting code package status, this option Limit the counts of tasks to those that were last modified before this time specified. Time should be formatted as the number of seconds since the Unix epoch
Endpoint - The URL where Iron’s services can be reached by your application
env_vars - Environment variables accessible within your code. It's a JSON object consisting corresponding key/value pairs. Keys and values are intended to be alphanumeric; if you want to pass values composed of wider list of symbols, consider to encode value with base64 encoding and decode it back within your code
error - This is the task status when there is an error during processing
Exponential Backoff - If a 503 error code is returned, retrying the request with increasing delays until it succeeds or a maximum number of retries (configured by the client) has been reached
from_time - When getting a list of tasks, this optional parameter is used to limit the retrieved tasks to only those that were created after the time specified in the value
Host - This is the cluster you are running your workers on
Image - This is the docker image you will be running your workers in
killed - This is the task status when a task is killed by the system
max_concurrency - The maximum number of workers that should be run in parallel
msg - Used when setting a task’s progress. Any message or data describing the completion of the task. Must be a string value, and the 64KB request limit applies
name - A unique name for your worker. This will be used to assign tasks to the worker as well as to update the code. If a worker with this name already exists, the code you are uploading will be added as a new revision
page - This optional query parameter is used when retrieving tasks. The page of tasks you want to retrieve, starting from 0. Default is 0, maximum is 100
payload - A string of data to be passed to the worker (usually JSON) so the worker knows exactly what worker it should perform. This is the equivalent to a message in a typical message queue. The payload will be available in a file that your worker can access. File location will be passed in via the -payload argument. The payload cannot be larger than 64KB in size
per_page - When querying tasks, this optional parameter is used to set how many are returned
percent - When checking a task’s progress, an integer, between 0 and 100 inclusive, that describes the completion of the task
priority - The priority queue to run the task in. Valid values are 0, 1, and 2. Task priority determines how much time a task may sit in queue. Higher values means tasks spend less time in the queue once they come off the schedule. The standard/default priority is 0
Project ID - This is the unique identifier for your project. It is a 24 character alphanumeric string
Queued - This is a task that has been placed in the queue and is waiting for it’s turn to execute
retries_delay - The number of seconds to wait before retries. If omitted, tasks will be immediately retried
retries - The maximum number of times failed tasks should be retried, in the event that there's an error while running them. If omitted, tasks will not be retried. Tasks cannot be retried more than ten times
revision - When working with code packages, this parameter allows you to get a specific version of the code package. If omitted, the latest will be used
run_every - When scheduling a task, this sets the amount of time, in seconds, between runs. By default, the task will only run once
Running - This is the task status when the task has started, but is not finished
Runtime - This is a holdover from the .worker file days. It was used to declare the programming language you are working in
Stack - This shows the optional programming stacks to run your code in
start_at - When scheduling a task, this optional parameter sets when the task should first be run
start_date - When getting a code package status, this optional parameter limits the counts of tasks to those that were last modified after this time specified. Time should be formatted as the number of seconds since the Unix epoch
Task - Tasks are specific instance of your workers being run. They encompass a single execution of a code package. Tasks consist of the code package to be run and the data to pass to the code package
timeout - The maximum runtime of your task in seconds. No task can exceed 3600 seconds (60 minutes). The default is 3600 but can be set to a shorter duration
to_time - When getting a list of tasks, this optional parameter limits the retrieved tasks to only those that were created before the time specified in the value. Time should be formatted as the number of seconds since the Unix epoch
URL Parameters - These are elements in a URL you can use to customize the endpoint