public class TaskDefinitionResponse extends Object
Definition of a task that can be scheduled
Modifier and Type | Field and Description |
---|---|
Date |
created
Creation time of taskSee https://schemas.taskcluster.net/queue/v1/task.json#/properties/created
|
Date |
deadline
Deadline of the task,
pending and running runs are resolved as exception if not resolved by other means before the deadline. |
String[] |
dependencies
List of dependent tasks.
|
Date |
expires
Task expiration, time at which task definition and status is deleted.
|
Object |
extra
Object with properties that can hold any kind of extra data that should be associated with the task.
|
TaskMetadata |
metadata
|
Object |
payload
Task-specific payload following worker-specific format.
|
String |
priority
Priority of task.
|
String |
provisionerId
Unique identifier for a provisioner, that can supply specified
workerType Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22See https://schemas.taskcluster.net/queue/v1/task.json#/properties/provisionerId |
String |
requires
The tasks relation to its dependencies.
|
int |
retries
Number of times to retry the task in case of infrastructure issues.
|
String[] |
routes
List of task-specific routes.
|
String |
schedulerId
All tasks in a task group must have the same
schedulerId . |
String[] |
scopes
List of scopes that the task is authorized to use during its execution.
|
Object |
tags
Arbitrary key-value tags (only strings limited to 4k).
|
String |
taskGroupId
Identifier for a group of tasks scheduled together with this task.
|
String |
workerType
Unique identifier for a worker-type within a specific provisionerSyntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22See https://schemas.taskcluster.net/queue/v1/task.json#/properties/workerType
|
Constructor and Description |
---|
TaskDefinitionResponse() |
public Date created
Creation time of task
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/created
public Date deadline
Deadline of the task, pending
and running
runs are resolved as exception if not resolved by other means before the deadline. Note, deadline cannot be more than 5 days into the future
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/deadline
public String[] dependencies
List of dependent tasks. These must either be completed or resolved before this task is scheduled. See requires
for semantics.
Default: []
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/dependencies
public Date expires
Task expiration, time at which task definition and status is deleted. Notice that all artifacts for the task must have an expiration that is no later than this. If this property isn’t it will be set to deadline
plus one year (this default may change).
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/expires
public Object extra
Object with properties that can hold any kind of extra data that should be associated with the task. This can be data for the task which doesn’t fit into payload
, or it can supplementary data for use in services listening for events from this task. For example this could be details to display on treeherder, or information for indexing the task. Please, try to put all related information under one property, so extra
data keys for treeherder reporting and task indexing don’t conflict, hence, we have reusable services. Warning, do not stuff large data-sets in here – task definitions should not take-up multiple MiBs.
Default: {}
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/extra
public TaskMetadata metadata
public Object payload
Task-specific payload following worker-specific format. Refer to the documentation for the worker implementing <provisionerId>/<workerType>
for details.
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/payload
public String priority
Priority of task. This defaults to lowest
and the scope queue:create-task:<priority>/<provisionerId>/<workerType>
is required to define a task with <priority>
. The normal
priority is treated as lowest
.
Possible values: * “highest” * “very-high” * “high” * “medium” * “low” * “very-low” * “lowest” * “normal” Default: “lowest”
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/priority
public String provisionerId
Unique identifier for a provisioner, that can supply specified workerType
Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/provisionerId
public String requires
The tasks relation to its dependencies. This property specifies the semantics of the task.dependencies
property. If all-completed
is given the task will be scheduled when all dependencies are resolved completed (successful resolution). If all-resolved
is given the task will be scheduled when all dependencies have been resolved, regardless of what their resolution is.
Possible values: * “all-completed” * “all-resolved” Default: “all-completed”
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/requires
public int retries
Number of times to retry the task in case of infrastructure issues. An infrastructure issue is a worker node that crashes or is shutdown, these events are to be expected.
Default: 5 Mininum: 0 Maximum: 49
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/retries
public String[] routes
List of task-specific routes. Pulse messages about the task will be CC’ed to route.<value>
for each <value>
in this array.
Default: []
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/routes
public String schedulerId
All tasks in a task group must have the same schedulerId
. This is used for several purposes:
createTask
must have a scope related to the schedulerId
of the task group;schedulerId
-related scopes; andDefault: “-” Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/schedulerId
public String[] scopes
List of scopes that the task is authorized to use during its execution.
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/scopes
public Object tags
Arbitrary key-value tags (only strings limited to 4k). These can be used to attach informal metadata to a task. Use this for informal tags that tasks can be classified by. You can also think of strings here as candidates for formal metadata. Something like purpose: 'build' || 'test'
is a good example.
Default: {}
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/tags
public String taskGroupId
Identifier for a group of tasks scheduled together with this task. Generally, all tasks related to a single event such as a version-control push or a nightly build have the same taskGroupId
. This property defaults to taskId
if it isn’t specified. Tasks with taskId
equal to the taskGroupId
are, by convention, decision tasks.
Syntax: ^[A-Za-z0-9_-]{8}[Q-T][A-Za-z0-9_-][CGKOSWaeimquy26-][A-Za-z0-9_-]{10}[AQgw]$
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/taskGroupId
public String workerType
Unique identifier for a worker-type within a specific provisioner
Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22
See https://schemas.taskcluster.net/queue/v1/task.json#/properties/workerType
Copyright © 2014–2018 Mozilla. All rights reserved.