org.mozilla.taskcluster.client.queue

Class TaskDefinitionResponse

java.lang.Object

org.mozilla.taskcluster.client.queue.TaskDefinitionResponse

public class TaskDefinitionResponse
extends Object

Definition of a task that can be scheduled

See http://schemas.taskcluster.net/queue/v1/task.json#

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TaskDefinitionResponse.Metadata

Field Summary

Fields

Modifier and Type	Field and Description
Date	created Creation time of task
Date	deadline Deadline of the task, pending and running runs are resolved as failed 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.
TaskDefinitionResponse.Metadata	metadata Required task metadata
Object	payload Task-specific payload following worker-specific format.
String	priority Priority of task, this defaults to normal and the scope queue:task-priority:high is required to define a task with priority set to high.
String	provisionerId Unique identifier for a provisioner, that can supply specified workerType
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, AMQP messages will be CC’ed to these routes.
String	schedulerId Identifier for the scheduler that defined this task, this can be an identifier for a user or a service like the "task-graph-scheduler".
String[]	scopes List of scopes (or scope-patterns) that the task is authorized to use.
Object	tags Arbitrary key-value tags (only strings limited to 4k).
String	taskGroupId Identifier for a group of tasks scheduled together with this task, by scheduler identified by schedulerId.
String	workerType Unique identifier for a worker-type within a specific provisioner

Constructor Summary

Constructors

Constructor and Description
TaskDefinitionResponse()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

created

public Date created

Creation time of task

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/created

deadline

public Date deadline

Deadline of the task, pending and running runs are resolved as failed if not resolved by other means before the deadline. Note, deadline cannot be more than 5 days into the future

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/deadline

dependencies

public String[] dependencies

List of dependent tasks. These must either be completed or resolved before this task is scheduled. See requires for semantics.

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/dependencies

expires

public Date expires

Task expiration, time at which task definition and status is deleted. Notice that all artifacts for the 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 subject to change).

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/expires

extra

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: map[]

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/extra

metadata

public TaskDefinitionResponse.Metadata metadata

Required task metadata

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata

payload

public Object payload

Task-specific payload following worker-specific format. For example the docker-worker requires keys like: image, commands and features. Refer to the documentation of docker-worker for details.

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/payload

priority

public String priority

Priority of task, this defaults to normal and the scope queue:task-priority:high is required to define a task with priority set to high. Additional priority levels may be added later.

Possible values: * “high” * “normal”

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/priority

provisionerId

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 http://schemas.taskcluster.net/queue/v1/task.json#/properties/provisionerId

requires

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”

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/requires

retries

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.

Mininum: 0 Maximum: 49

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/retries

routes

public String[] routes

List of task specific routes, AMQP messages will be CC’ed to these routes.

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/routes

schedulerId

public String schedulerId

Identifier for the scheduler that defined this task, this can be an identifier for a user or a service like the "task-graph-scheduler". Along with the taskGroupId this is used to form the permission scope queue:assume:scheduler-id:<schedulerId>/<taskGroupId>, this scope is necessary to schedule a defined task, or rerun a task.

Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/schedulerId

scopes

public String[] scopes

List of scopes (or scope-patterns) that the task is authorized to use.

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/scopes

tags

public Object tags

Arbitrary key-value tags (only strings limited to 4k). These can be used to attach informal meta-data 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 meta-data. Something like purpose: 'build' || 'test' is a good example.

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/tags

taskGroupId

public String taskGroupId

Identifier for a group of tasks scheduled together with this task, by scheduler identified by schedulerId. For tasks scheduled by the task-graph scheduler, this is the taskGraphId. Defaults to taskId if property isn’t specified.

Syntax: ^[A-Za-z0-9_-]{8}[Q-T][A-Za-z0-9_-][CGKOSWaeimquy26-][A-Za-z0-9_-]{10}[AQgw]$

See http://schemas.taskcluster.net/queue/v1/task.json#/properties/taskGroupId

workerType

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 http://schemas.taskcluster.net/queue/v1/task.json#/properties/workerType

Constructor Detail

TaskDefinitionResponse

public TaskDefinitionResponse()