queue

package
v0.0.0-...-e809d2b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 30, 2016 License: MPL-2.0 Imports: 5 Imported by: 0

Documentation

Overview

The queue, typically available at `queue.taskcluster.net`, is responsible for accepting tasks and track their state as they are executed by workers. In order ensure they are eventually resolved.

This document describes the API end-points offered by the queue. These end-points targets the following audience:

  • Schedulers, who create tasks to be executed,
  • Workers, who execute tasks, and
  • Tools, that wants to inspect the state of a task.

See: https://docs.taskcluster.net/reference/platform/queue/api-docs

How to use this package

First create a Queue object: 

myQueue := queue.New(&tcclient.Credentials{ClientId: "myClientId", AccessToken: "myAccessToken"})

and then call one or more of myQueue's methods, e.g.: 

data, err := myQueue.Task(.....)

handling any errors... 

if err != nil {
	// handle error...
}

TaskCluster Schema

The source code of this go package was auto-generated from the API definition at http://references.taskcluster.net/queue/v1/api.json together with the input and output schemas it references, downloaded on Fri, 30 Dec 2016 at 09:23:00 UTC. The code was generated by https://github.com/taskcluster/taskcluster-client-go/blob/master/build.sh.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AzureArtifactRequest 

type AzureArtifactRequest struct {

	// Artifact mime-type, when uploading artifact please use the same
	// `Content-Type`, consistently using the correct mime-type make
	// tooling a lot easier, specifically, always using `application/json`
	// for JSON artifacts.
	//
	// Max length: 255
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[1]/properties/contentType
	ContentType string `json:"contentType"`

	// Date-time after which the artifact should be deleted.
	// Note, that these will be collected over time, and artifacts may
	// remain available after expiration. Azure based artifacts are
	// identified in azure table storage and explicitly deleted in the
	// azure storage container after expiration.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[1]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Artifact storage type, in this case `azure`
	//
	// Possible values:
	//   * "azure"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[1]/properties/storageType
	StorageType string `json:"storageType"`
}

Request for an Azure Shared Access Signature (SAS) that will allow you to upload an artifact to an Azure blob storage container managed by the queue.

See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[1]

type AzureArtifactResponse 

type AzureArtifactResponse struct {

	// Artifact mime-type, should be specified with the
	// `x-ms-blob-content-type` when committing the block.
	//
	// Max length: 255
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[1]/properties/contentType
	ContentType string `json:"contentType"`

	// Date-time after which Shared Access Signature (SAS) will
	// seize to work.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[1]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Shared Access Signature (SAS) with write permissions, see
	// [Azure REST API]
	// (http://msdn.microsoft.com/en-US/library/azure/dn140256.aspx)
	// reference for details on how to use this.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[1]/properties/putUrl
	PutURL string `json:"putUrl"`

	// Artifact storage type, in this case `azure`
	//
	// Possible values:
	//   * "azure"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[1]/properties/storageType
	StorageType string `json:"storageType"`
}

Response to a request for an Azure Shared Access Signature (SAS) that will allow you to upload an artifact to an Azure blob storage container managed by the queue.

See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[1]

type ClaimWorkRequest 

type ClaimWorkRequest struct {

	// Number of tasks to attempt to claim.
	//
	// Default:    1
	// Mininum:    1
	// Maximum:    32
	//
	// See http://schemas.taskcluster.net/queue/v1/claim-work-request.json#/properties/tasks
	Tasks int `json:"tasks"`

	// Identifier for group that worker claiming the task is a part of.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/claim-work-request.json#/properties/workerGroup
	WorkerGroup string `json:"workerGroup"`

	// Identifier for worker within the given workerGroup
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/claim-work-request.json#/properties/workerId
	WorkerID string `json:"workerId"`
}

Request to claim a task for a worker to process.

See http://schemas.taskcluster.net/queue/v1/claim-work-request.json#

type ClaimWorkResponse 

type ClaimWorkResponse struct {

	// List of task claims, may be empty if no tasks was claimed, in which case
	// the worker should sleep a tiny bit before polling again.
	//
	// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks
	Tasks []struct {

		// Temporary credentials granting `task.scopes` and the scope:
		// `queue:claim-task:<taskId>/<runId>` which allows the worker to reclaim
		// the task, upload artifacts and report task resolution.
		//
		// The temporary credentials are set to expire after `takenUntil`. They
		// won't expire exactly at `takenUntil` but shortly after, hence, requests
		// coming close `takenUntil` won't have problems even if there is a little
		// clock drift.
		//
		// Workers should use these credentials when making requests on behalf of
		// a task. This includes requests to create artifacts, reclaiming the task
		// reporting the task `completed`, `failed` or `exception`.
		//
		// Note, a new set of temporary credentials is issued when the worker
		// reclaims the task.
		//
		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/credentials
		Credentials struct {

			// The `accessToken` for the temporary credentials.
			//
			// Min length: 1
			//
			// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/credentials/properties/accessToken
			AccessToken string `json:"accessToken"`

			// The `certificate` for the temporary credentials, these are required
			// for the temporary credentials to work.
			//
			// Min length: 1
			//
			// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/credentials/properties/certificate
			Certificate string `json:"certificate"`

			// The `clientId` for the temporary credentials.
			//
			// Min length: 1
			//
			// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/credentials/properties/clientId
			ClientID string `json:"clientId"`
		} `json:"credentials"`

		// `run-id` assigned to this run of the task
		//
		// Mininum:    0
		// Maximum:    1000
		//
		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/runId
		RunID int `json:"runId"`

		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/status
		Status TaskStatusStructure `json:"status"`

		// Time at which the run expires and is resolved as `exception`,
		// with reason `claim-expired` if the run haven't been reclaimed.
		//
		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/takenUntil
		TakenUntil tcclient.Time `json:"takenUntil"`

		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/task
		Task TaskDefinitionResponse `json:"task"`

		// Identifier for the worker-group within which this run started.
		//
		// Syntax:     ^([a-zA-Z0-9-_]*)$
		// Min length: 1
		// Max length: 22
		//
		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/workerGroup
		WorkerGroup string `json:"workerGroup"`

		// Identifier for the worker executing this run.
		//
		// Syntax:     ^([a-zA-Z0-9-_]*)$
		// Min length: 1
		// Max length: 22
		//
		// See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#/properties/tasks/items/properties/workerId
		WorkerID string `json:"workerId"`
	} `json:"tasks"`
}

Response to an attempt to claim tasks for a worker to process.

See http://schemas.taskcluster.net/queue/v1/claim-work-response.json#

type CountPendingTasksResponse 

type CountPendingTasksResponse struct {

	// An approximate number of pending tasks for the given `provisionerId` and
	// `workerType`. This is based on Azure Queue Storage meta-data API, thus,
	// number of reported here may be higher than actual number of pending tasks.
	// But there cannot be more pending tasks reported here. Ie. this is an
	// **upper-bound** on the number of pending tasks.
	//
	// Mininum:    0
	//
	// See http://schemas.taskcluster.net/queue/v1/pending-tasks-response.json#/properties/pendingTasks
	PendingTasks int `json:"pendingTasks"`

	// Unique identifier for the provisioner
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/pending-tasks-response.json#/properties/provisionerId
	ProvisionerID string `json:"provisionerId"`

	// Identifier for worker type within the specified provisioner
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/pending-tasks-response.json#/properties/workerType
	WorkerType string `json:"workerType"`
}

Response to a request for the number of pending tasks for a given `provisionerId` and `workerType`.

See http://schemas.taskcluster.net/queue/v1/pending-tasks-response.json#

type ErrorArtifactRequest 

type ErrorArtifactRequest struct {

	// Date-time after which the queue should stop replying with the error
	// and forget about the artifact.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[3]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Human readable explanation of why the artifact is missing
	//
	// Max length: 4096
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[3]/properties/message
	Message string `json:"message"`

	// Reason why the artifact doesn't exist.
	//
	// Possible values:
	//   * "file-missing-on-worker"
	//   * "invalid-resource-on-worker"
	//   * "too-large-file-on-worker"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[3]/properties/reason
	Reason string `json:"reason"`

	// Artifact storage type, in this case `error`
	//
	// Possible values:
	//   * "error"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[3]/properties/storageType
	StorageType string `json:"storageType"`
}

Request the queue to reply `403` (forbidden) with `reason` and `message` to any `GET` request for this artifact. This is mainly useful as a way for a task to declare that it failed to provide an artifact it wanted to upload.

See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[3]

type ErrorArtifactResponse 

type ErrorArtifactResponse struct {

	// Artifact storage type, in this case `error`
	//
	// Possible values:
	//   * "error"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[3]/properties/storageType
	StorageType string `json:"storageType"`
}

Response to a request for the queue to reply `403` (forbidden) with `reason` and `message` to any `GET` request for this artifact.

See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[3]

type ListArtifactsResponse 

type ListArtifactsResponse struct {

	// List of artifacts for given `taskId` and `runId`.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/artifacts
	Artifacts []struct {

		// Mimetype for the artifact that was created.
		//
		// Max length: 255
		//
		// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/artifacts/items/properties/contentType
		ContentType string `json:"contentType"`

		// Date and time after which the artifact created will be automatically
		// deleted by the queue.
		//
		// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/artifacts/items/properties/expires
		Expires tcclient.Time `json:"expires"`

		// Name of the artifact that was created, this is useful if you want to
		// attempt to fetch the artifact.
		//
		// Max length: 1024
		//
		// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/artifacts/items/properties/name
		Name string `json:"name"`

		// This is the `storageType` for the request that was used to create
		// the artifact.
		//
		// Possible values:
		//   * "s3"
		//   * "azure"
		//   * "reference"
		//   * "error"
		//
		// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/artifacts/items/properties/storageType
		StorageType string `json:"storageType"`
	} `json:"artifacts"`

	// Opaque `continuationToken` to be given as query-string option to get the
	// next set of artifacts.
	// This property is only present if another request is necessary to fetch all
	// results. In practice the next request with a `continuationToken` may not
	// return additional results, but it can. Thus, you can only be sure to have
	// all the results if you've called with `continuationToken` until you get a
	// result without a `continuationToken`.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#/properties/continuationToken
	ContinuationToken string `json:"continuationToken,omitempty"`
}

List of artifacts for a given `taskId` and `runId`.

See http://schemas.taskcluster.net/queue/v1/list-artifacts-response.json#

type ListDependentTasksResponse 

type ListDependentTasksResponse struct {

	// Opaque `continuationToken` to be given as query-string option to get the
	// next set of dependent tasks.
	// This property is only present if another request is necessary to fetch all
	// results. In practice the next request with a `continuationToken` may not
	// return additional results, but it can. Thus, you can only be sure to have
	// all the results if you've called `listDependentTasks` with
	// `continuationToken` until you get a result without a `continuationToken`.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-dependent-tasks-response.json#/properties/continuationToken
	ContinuationToken string `json:"continuationToken,omitempty"`

	// Identifier for the task whose dependents are being listed.
	//
	// 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/list-dependent-tasks-response.json#/properties/taskId
	TaskID string `json:"taskId"`

	// List of tasks that have `taskId` in the `task.dependencies` property.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-dependent-tasks-response.json#/properties/tasks
	Tasks []struct {

		// See http://schemas.taskcluster.net/queue/v1/list-dependent-tasks-response.json#/properties/tasks/items/properties/status
		Status TaskStatusStructure `json:"status"`

		// See http://schemas.taskcluster.net/queue/v1/list-dependent-tasks-response.json#/properties/tasks/items/properties/task
		Task TaskDefinitionResponse `json:"task"`
	} `json:"tasks"`
}

Response from a `listDependentTasks` request.

See http://schemas.taskcluster.net/queue/v1/list-dependent-tasks-response.json#

type ListTaskGroupResponse 

type ListTaskGroupResponse struct {

	// Opaque `continuationToken` to be given as query-string option to get the
	// next set of tasks in the task-group.
	// This property is only present if another request is necessary to fetch all
	// results. In practice the next request with a `continuationToken` may not
	// return additional results, but it can. Thus, you can only be sure to have
	// all the results if you've called `listTaskGroup` with `continuationToken`
	// until you get a result without a `continuationToken`.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-task-group-response.json#/properties/continuationToken
	ContinuationToken string `json:"continuationToken,omitempty"`

	// Identifier for the task-group being listed.
	//
	// 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/list-task-group-response.json#/properties/taskGroupId
	TaskGroupID string `json:"taskGroupId"`

	// List of tasks in this task-group.
	//
	// See http://schemas.taskcluster.net/queue/v1/list-task-group-response.json#/properties/tasks
	Tasks []struct {

		// See http://schemas.taskcluster.net/queue/v1/list-task-group-response.json#/properties/tasks/items/properties/status
		Status TaskStatusStructure `json:"status"`

		// See http://schemas.taskcluster.net/queue/v1/list-task-group-response.json#/properties/tasks/items/properties/task
		Task TaskDefinitionResponse `json:"task"`
	} `json:"tasks"`
}

Response from a `listTaskGroup` request.

See http://schemas.taskcluster.net/queue/v1/list-task-group-response.json#

type PollTaskUrlsResponse 

type PollTaskUrlsResponse struct {

	// Date and time after which the signed URLs provided in this response
	// expires and not longer works for authentication.
	//
	// See http://schemas.taskcluster.net/queue/v1/poll-task-urls-response.json#/properties/expires
	Expires tcclient.Time `json:"expires"`

	// List of signed URLs for queues to poll tasks from, they must be called
	// in the order they are given. As the first entry in this array **may**
	// have higher priority.
	//
	// See http://schemas.taskcluster.net/queue/v1/poll-task-urls-response.json#/properties/queues
	Queues []struct {

		// Signed URL to delete messages that have been received using the
		// `signedPollUrl`. You **must** do this to avoid receiving the same
		// message again.
		// To use this URL you must substitute `{{messageId}}` and
		// `{{popReceipt}}` with `MessageId` and `PopReceipt` from the XML
		// response the `signedPollUrl` gave you. It is important that you
		// `encodeURIComponent` both `MessageId` and `PopReceipt` prior to
		// substitution, otherwise you will experience intermittent failures!
		// Note this URL only works with `DELETE` request.
		//
		// Syntax:     ^https://
		//
		// See http://schemas.taskcluster.net/queue/v1/poll-task-urls-response.json#/properties/queues/items/properties/signedDeleteUrl
		SignedDeleteURL string `json:"signedDeleteUrl"`

		// Signed URL to get message from the Azure Queue Storage queue,
		// that holds messages for the given `provisionerId` and `workerType`.
		// Note that this URL returns XML, see documentation for the Azure
		// Queue Storage
		// [REST API](http://msdn.microsoft.com/en-us/library/azure/dd179474.aspx)
		// for details.
		// When you have a message you can use `claimTask` to claim the task.
		// You will need to parse the XML reponse and base64 decode and
		// JSON parse the `MessageText`.
		// After you have called `claimTask` you **must** us the
		// `signedDeleteUrl` to delete the message.
		// **Remark**, you are allowed to append `&numofmessages=N`,
		// where N < 32, to the URLs if you wish to obtain more than one
		// message at the time.
		//
		// See http://schemas.taskcluster.net/queue/v1/poll-task-urls-response.json#/properties/queues/items/properties/signedPollUrl
		SignedPollURL string `json:"signedPollUrl"`
	} `json:"queues"`
}

Response to request for poll task urls.

See http://schemas.taskcluster.net/queue/v1/poll-task-urls-response.json#

type PostArtifactRequest 

type PostArtifactRequest json.RawMessage

Request a authorization to put and artifact or posting of a URL as an artifact. Note that the `storageType` property is referenced in the response as well.

See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#

func (*PostArtifactRequest) MarshalJSON 

func (this *PostArtifactRequest) MarshalJSON() ([]byte, error)

MarshalJSON calls json.RawMessage method of the same name. Required since PostArtifactRequest is of type json.RawMessage...

func (*PostArtifactRequest) UnmarshalJSON 

func (this *PostArtifactRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON is a copy of the json.RawMessage implementation.

type PostArtifactResponse 

type PostArtifactResponse json.RawMessage

Response to a request for posting an artifact. Note that the `storageType` property is referenced in the request as well.

See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#

func (*PostArtifactResponse) MarshalJSON 

func (this *PostArtifactResponse) MarshalJSON() ([]byte, error)

MarshalJSON calls json.RawMessage method of the same name. Required since PostArtifactResponse is of type json.RawMessage...

func (*PostArtifactResponse) UnmarshalJSON 

func (this *PostArtifactResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON is a copy of the json.RawMessage implementation.

type Queue 

type Queue tcclient.ConnectionData

func New 

func New(credentials *tcclient.Credentials) *Queue

Returns a pointer to Queue, configured to run against production. If you wish to point at a different API endpoint url, set BaseURL to the preferred url. Authentication can be disabled (for example if you wish to use the taskcluster-proxy) by setting Authenticate to false (in which case creds is ignored).

For example: 

creds := &tcclient.Credentials{
	ClientId:    os.Getenv("TASKCLUSTER_CLIENT_ID"),
	AccessToken: os.Getenv("TASKCLUSTER_ACCESS_TOKEN"),
	Certificate: os.Getenv("TASKCLUSTER_CERTIFICATE"),
}
myQueue := queue.New(creds)                              // set credentials
myQueue.Authenticate = false                             // disable authentication (creds above are now ignored)
myQueue.BaseURL = "http://localhost:1234/api/Queue/v1"   // alternative API endpoint (production by default)
data, err := myQueue.Task(.....)                         // for example, call the Task(.....) API endpoint (described further down)...
if err != nil {
	// handle errors...
}

func (*Queue) CancelTask 

func (myQueue *Queue) CancelTask(taskId string) (*TaskStatusResponse, error)

This method will cancel a task that is either `unscheduled`, `pending` or `running`. It will resolve the current run as `exception` with `reasonResolved` set to `canceled`. If the task isn't scheduled yet, ie. it doesn't have any runs, an initial run will be added and resolved as described above. Hence, after canceling a task, it cannot be scheduled with `queue.scheduleTask`, but a new run can be created with `queue.rerun`. These semantics is equivalent to calling `queue.scheduleTask` immediately followed by `queue.cancelTask`.

**Remark** this operation is idempotent, if you try to cancel a task that isn't `unscheduled`, `pending` or `running`, this operation will just return the current task status.

Required scopes:

  • (queue:cancel-task and assume:scheduler-id:<schedulerId>/<taskGroupId>), or
  • queue:cancel-task:<schedulerId>/<taskGroupId>/<taskId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#cancelTask

func (*Queue) ClaimTask 

func (myQueue *Queue) ClaimTask(taskId, runId string, payload *TaskClaimRequest) (*TaskClaimResponse, error)

claim a task, more to be added later...

Required scopes:

  • (queue:claim-task and assume:worker-type:<provisionerId>/<workerType> and assume:worker-id:<workerGroup>/<workerId>), or
  • (queue:claim-task:<provisionerId>/<workerType> and queue:worker-id:<workerGroup>/<workerId>)

See https://docs.taskcluster.net/reference/platform/queue/api-docs#claimTask

func (*Queue) ClaimWork 

func (myQueue *Queue) ClaimWork(provisionerId, workerType string, payload *ClaimWorkRequest) (*ClaimWorkResponse, error)

Claim any task, more to be added later... long polling up to 20s.

Required scopes:

  • queue:claim-work:<provisionerId>/<workerType>, and
  • queue:worker-id:<workerGroup>/<workerId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#claimWork

func (*Queue) CreateArtifact 

func (myQueue *Queue) CreateArtifact(taskId, runId, name string, payload *PostArtifactRequest) (*PostArtifactResponse, error)

This API end-point creates an artifact for a specific run of a task. This should **only** be used by a worker currently operating on this task, or from a process running within the task (ie. on the worker).

All artifacts must specify when they `expires`, the queue will automatically take care of deleting artifacts past their expiration point. This features makes it feasible to upload large intermediate artifacts from data processing applications, as the artifacts can be set to expire a few days later.

We currently support 4 different `storageType`s, each storage type have slightly different features and in some cases difference semantics.

**S3 artifacts**, is useful for static files which will be stored on S3. When creating an S3 artifact the queue will return a pre-signed URL to which you can do a `PUT` request to upload your artifact. Note that `PUT` request **must** specify the `content-length` header and **must** give the `content-type` header the same value as in the request to `createArtifact`.

**Azure artifacts**, are stored in _Azure Blob Storage_ service, which given the consistency guarantees and API interface offered by Azure is more suitable for artifacts that will be modified during the execution of the task. For example docker-worker has a feature that persists the task log to Azure Blob Storage every few seconds creating a somewhat live log. A request to create an Azure artifact will return a URL featuring a [Shared-Access-Signature](http://msdn.microsoft.com/en-us/library/azure/dn140256.aspx), refer to MSDN for further information on how to use these. **Warning: azure artifact is currently an experimental feature subject to changes and data-drops.**

**Reference artifacts**, only consists of meta-data which the queue will store for you. These artifacts really only have a `url` property and when the artifact is requested the client will be redirect the URL provided with a `303` (See Other) redirect. Please note that we cannot delete artifacts you upload to other service, we can only delete the reference to the artifact, when it expires.

**Error artifacts**, only consists of meta-data which the queue will store for you. These artifacts are only meant to indicate that you the worker or the task failed to generate a specific artifact, that you would otherwise have uploaded. For example docker-worker will upload an error artifact, if the file it was supposed to upload doesn't exists or turns out to be a directory. Clients requesting an error artifact will get a `403` (Forbidden) response. This is mainly designed to ensure that dependent tasks can distinguish between artifacts that were suppose to be generated and artifacts for which the name is misspelled.

**Artifact immutability**, generally speaking you cannot overwrite an artifact when created. But if you repeat the request with the same properties the request will succeed as the operation is idempotent. This is useful if you need to refresh a signed URL while uploading. Do not abuse this to overwrite artifacts created by another entity! Such as worker-host overwriting artifact created by worker-code.

As a special case the `url` property on _reference artifacts_ can be updated. You should only use this to update the `url` property for reference artifacts your process has created.

Required scopes:

  • (queue:create-artifact:<name> and assume:worker-id:<workerGroup>/<workerId>), or
  • queue:create-artifact:<taskId>/<runId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#createArtifact

func (*Queue) CreateTask 

func (myQueue *Queue) CreateTask(taskId string, payload *TaskDefinitionRequest) (*TaskStatusResponse, error)

Create a new task, this is an **idempotent** operation, so repeat it if you get an internal server error or network connection is dropped.

**Task `deadline´**, the deadline property can be no more than 5 days into the future. This is to limit the amount of pending tasks not being taken care of. Ideally, you should use a much shorter deadline.

**Task expiration**, the `expires` property must be greater than the task `deadline`. If not provided it will default to `deadline` + one year. Notice, that artifacts created by task must expire before the task.

**Task specific routing-keys**, using the `task.routes` property you may define task specific routing-keys. If a task has a task specific routing-key: `<route>`, then when the AMQP message about the task is published, the message will be CC'ed with the routing-key: `route.<route>`. This is useful if you want another component to listen for completed tasks you have posted. The caller must have scope `queue:route:<route>` for each route.

**Dependencies**, any tasks referenced in `task.dependencies` must have already been created at the time of this call.

**Important** Any scopes the task requires are also required for creating the task. Please see the Request Payload (Task Definition) for details.

Required scopes:

  • queue:create-task:<provisionerId>/<workerType>, or
  • (queue:define-task:<provisionerId>/<workerType> and queue:task-group-id:<schedulerId>/<taskGroupId> and queue:schedule-task:<schedulerId>/<taskGroupId>/<taskId>)

See https://docs.taskcluster.net/reference/platform/queue/api-docs#createTask

func (*Queue) DefineTask 

func (myQueue *Queue) DefineTask(taskId string, payload *TaskDefinitionRequest) (*TaskStatusResponse, error)

Stability: *** DEPRECATED ***

Define a task without scheduling it. This API end-point allows you to upload a task definition without having scheduled. The task won't be reported as pending until it is scheduled, see the scheduleTask API end-point.

The purpose of this API end-point is allow schedulers to upload task definitions without the tasks becoming _pending_ immediately. This useful if you have a set of dependent tasks. Then you can upload all the tasks and when the dependencies of a tasks have been resolved, you can schedule the task by calling `/task/:taskId/schedule`. This eliminates the need to store tasks somewhere else while waiting for dependencies to resolve.

**Important** Any scopes the task requires are also required for defining the task. Please see the Request Payload (Task Definition) for details.

**Note** this operation is **idempotent**, as long as you upload the same task definition as previously defined this operation is safe to retry.

Required scopes:

  • queue:define-task:<provisionerId>/<workerType>, or
  • queue:create-task:<provisionerId>/<workerType>, or
  • (queue:define-task:<provisionerId>/<workerType> and queue:task-group-id:<schedulerId>/<taskGroupId>)

See https://docs.taskcluster.net/reference/platform/queue/api-docs#defineTask

func (*Queue) GetArtifact 

func (myQueue *Queue) GetArtifact(taskId, runId, name string) error

Get artifact by `<name>` from a specific run.

**Public Artifacts**, in-order to get an artifact you need the scope `queue:get-artifact:<name>`, where `<name>` is the name of the artifact. But if the artifact `name` starts with `public/`, authentication and authorization is not necessary to fetch the artifact.

**API Clients**, this method will redirect you to the artifact, if it is stored externally. Either way, the response may not be JSON. So API client users might want to generate a signed URL for this end-point and use that URL with a normal HTTP client.

**Caching**, artifacts may be cached in data centers closer to the workers in-order to reduce bandwidth costs. This can lead to longer response times. Caching can be skipped by setting the header `x-taskcluster-skip-cache: true`, this should only be used for resources where request volume is known to be low, and caching not useful. (This feature may be disabled in the future, use is sparingly!)

Required scopes:

  • queue:get-artifact:<name>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#getArtifact

func (*Queue) GetArtifact_SignedURL 

func (myQueue *Queue) GetArtifact_SignedURL(taskId, runId, name string, duration time.Duration) (*url.URL, error)

Returns a signed URL for GetArtifact, valid for the specified duration.

Required scopes:

  • queue:get-artifact:<name>

See GetArtifact for more details.

func (*Queue) GetLatestArtifact 

func (myQueue *Queue) GetLatestArtifact(taskId, name string) error

Get artifact by `<name>` from the last run of a task.

**Public Artifacts**, in-order to get an artifact you need the scope `queue:get-artifact:<name>`, where `<name>` is the name of the artifact. But if the artifact `name` starts with `public/`, authentication and authorization is not necessary to fetch the artifact.

**API Clients**, this method will redirect you to the artifact, if it is stored externally. Either way, the response may not be JSON. So API client users might want to generate a signed URL for this end-point and use that URL with a normal HTTP client.

**Remark**, this end-point is slightly slower than `queue.getArtifact`, so consider that if you already know the `runId` of the latest run. Otherwise, just us the most convenient API end-point.

Required scopes:

  • queue:get-artifact:<name>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#getLatestArtifact

func (*Queue) GetLatestArtifact_SignedURL 

func (myQueue *Queue) GetLatestArtifact_SignedURL(taskId, name string, duration time.Duration) (*url.URL, error)

Returns a signed URL for GetLatestArtifact, valid for the specified duration.

Required scopes:

  • queue:get-artifact:<name>

See GetLatestArtifact for more details.

func (*Queue) ListArtifacts 

func (myQueue *Queue) ListArtifacts(taskId, runId, continuationToken, limit string) (*ListArtifactsResponse, error)

Stability: *** EXPERIMENTAL ***

Returns a list of artifacts and associated meta-data for a given run.

As a task may have many artifacts paging may be necessary. If this end-point returns a `continuationToken`, you should call the end-point again with the `continuationToken` as the query-string option: `continuationToken`.

By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter `limit`.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#listArtifacts

func (*Queue) ListDependentTasks 

func (myQueue *Queue) ListDependentTasks(taskId, continuationToken, limit string) (*ListDependentTasksResponse, error)

List tasks that depend on the given `taskId`.

As many tasks from different task-groups may dependent on a single tasks, this end-point may return a `continuationToken`. To continue listing tasks you must call `listDependentTasks` again with the `continuationToken` as the query-string option `continuationToken`.

By default this end-point will try to return up to 1000 tasks in one request. But it **may return less**, even if more tasks are available. It may also return a `continuationToken` even though there are no more results. However, you can only be sure to have seen all results if you keep calling `listDependentTasks` with the last `continuationToken` until you get a result without a `continuationToken`.

If you are not interested in listing all the tasks at once, you may use the query-string option `limit` to return fewer.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#listDependentTasks

func (*Queue) ListLatestArtifacts 

func (myQueue *Queue) ListLatestArtifacts(taskId, continuationToken, limit string) (*ListArtifactsResponse, error)

Stability: *** EXPERIMENTAL ***

Returns a list of artifacts and associated meta-data for the latest run from the given task.

As a task may have many artifacts paging may be necessary. If this end-point returns a `continuationToken`, you should call the end-point again with the `continuationToken` as the query-string option: `continuationToken`.

By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter `limit`.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#listLatestArtifacts

func (*Queue) ListTaskGroup 

func (myQueue *Queue) ListTaskGroup(taskGroupId, continuationToken, limit string) (*ListTaskGroupResponse, error)

List tasks sharing the same `taskGroupId`.

As a task-group may contain an unbounded number of tasks, this end-point may return a `continuationToken`. To continue listing tasks you must call the `listTaskGroup` again with the `continuationToken` as the query-string option `continuationToken`.

By default this end-point will try to return up to 1000 members in one request. But it **may return less**, even if more tasks are available. It may also return a `continuationToken` even though there are no more results. However, you can only be sure to have seen all results if you keep calling `listTaskGroup` with the last `continuationToken` until you get a result without a `continuationToken`.

If you are not interested in listing all the members at once, you may use the query-string option `limit` to return fewer.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#listTaskGroup

func (*Queue) PendingTasks 

func (myQueue *Queue) PendingTasks(provisionerId, workerType string) (*CountPendingTasksResponse, error)

Get an approximate number of pending tasks for the given `provisionerId` and `workerType`.

The underlying Azure Storage Queues only promises to give us an estimate. Furthermore, we cache the result in memory for 20 seconds. So consumers should be no means expect this to be an accurate number. It is, however, a solid estimate of the number of pending tasks.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#pendingTasks

func (*Queue) Ping 

func (myQueue *Queue) Ping() error

Respond without doing anything. This endpoint is used to check that the service is up.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#ping

func (*Queue) PollTaskUrls 

func (myQueue *Queue) PollTaskUrls(provisionerId, workerType string) (*PollTaskUrlsResponse, error)

Get a signed URLs to get and delete messages from azure queue. Once messages are polled from here, you can claim the referenced task with `claimTask`, and afterwards you should always delete the message.

Required scopes:

  • (queue:poll-task-urls and assume:worker-type:<provisionerId>/<workerType>), or
  • queue:poll-task-urls:<provisionerId>/<workerType>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#pollTaskUrls

func (*Queue) PollTaskUrls_SignedURL 

func (myQueue *Queue) PollTaskUrls_SignedURL(provisionerId, workerType string, duration time.Duration) (*url.URL, error)

Returns a signed URL for PollTaskUrls, valid for the specified duration.

Required scopes:

  • (queue:poll-task-urls and assume:worker-type:<provisionerId>/<workerType>), or
  • queue:poll-task-urls:<provisionerId>/<workerType>

See PollTaskUrls for more details.

func (*Queue) ReclaimTask 

func (myQueue *Queue) ReclaimTask(taskId, runId string) (*TaskReclaimResponse, error)

reclaim a task more to be added later...

Required scopes:

  • (queue:claim-task and assume:worker-id:<workerGroup>/<workerId>), or
  • queue:reclaim-task:<taskId>/<runId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#reclaimTask

func (*Queue) ReportCompleted 

func (myQueue *Queue) ReportCompleted(taskId, runId string) (*TaskStatusResponse, error)

Report a task completed, resolving the run as `completed`.

Required scopes:

  • (queue:resolve-task and assume:worker-id:<workerGroup>/<workerId>), or
  • queue:resolve-task:<taskId>/<runId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#reportCompleted

func (*Queue) ReportException 

func (myQueue *Queue) ReportException(taskId, runId string, payload *TaskExceptionRequest) (*TaskStatusResponse, error)

Resolve a run as _exception_. Generally, you will want to report tasks as failed instead of exception. You should `reportException` if,

  • The `task.payload` is invalid,
  • Non-existent resources are referenced,
  • Declared actions cannot be executed due to unavailable resources,
  • The worker had to shutdown prematurely,
  • The worker experienced an unknown error, or,
  • The task explicitely requested a retry.

Do not use this to signal that some user-specified code crashed for any reason specific to this code. If user-specific code hits a resource that is temporarily unavailable worker should report task _failed_.

Required scopes:

  • (queue:resolve-task and assume:worker-id:<workerGroup>/<workerId>), or
  • queue:resolve-task:<taskId>/<runId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#reportException

func (*Queue) ReportFailed 

func (myQueue *Queue) ReportFailed(taskId, runId string) (*TaskStatusResponse, error)

Report a run failed, resolving the run as `failed`. Use this to resolve a run that failed because the task specific code behaved unexpectedly. For example the task exited non-zero, or didn't produce expected output.

Do not use this if the task couldn't be run because if malformed payload, or other unexpected condition. In these cases we have a task exception, which should be reported with `reportException`.

Required scopes:

  • (queue:resolve-task and assume:worker-id:<workerGroup>/<workerId>), or
  • queue:resolve-task:<taskId>/<runId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#reportFailed

func (*Queue) RerunTask 

func (myQueue *Queue) RerunTask(taskId string) (*TaskStatusResponse, error)

Stability: *** DEPRECATED ***

This method _reruns_ a previously resolved task, even if it was _completed_. This is useful if your task completes unsuccessfully, and you just want to run it from scratch again. This will also reset the number of `retries` allowed.

Remember that `retries` in the task status counts the number of runs that the queue have started because the worker stopped responding, for example because a spot node died.

**Remark** this operation is idempotent, if you try to rerun a task that is not either `failed` or `completed`, this operation will just return the current task status.

Required scopes:

  • (queue:rerun-task and assume:scheduler-id:<schedulerId>/<taskGroupId>), or
  • queue:rerun-task:<schedulerId>/<taskGroupId>/<taskId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#rerunTask

func (*Queue) ScheduleTask 

func (myQueue *Queue) ScheduleTask(taskId string) (*TaskStatusResponse, error)

scheduleTask will schedule a task to be executed, even if it has unresolved dependencies. A task would otherwise only be scheduled if its dependencies were resolved.

This is useful if you have defined a task that depends on itself or on some other task that has not been resolved, but you wish the task to be scheduled immediately.

This will announce the task as pending and workers will be allowed to claim it and resolve the task.

**Note** this operation is **idempotent** and will not fail or complain if called with a `taskId` that is already scheduled, or even resolved. To reschedule a task previously resolved, use `rerunTask`.

Required scopes:

  • (queue:schedule-task and assume:scheduler-id:<schedulerId>/<taskGroupId>), or
  • queue:schedule-task:<schedulerId>/<taskGroupId>/<taskId>

See https://docs.taskcluster.net/reference/platform/queue/api-docs#scheduleTask

func (*Queue) Status 

func (myQueue *Queue) Status(taskId string) (*TaskStatusResponse, error)

Get task status structure from `taskId`

See https://docs.taskcluster.net/reference/platform/queue/api-docs#status

func (*Queue) Task 

func (myQueue *Queue) Task(taskId string) (*TaskDefinitionResponse, error)

This end-point will return the task-definition. Notice that the task definition may have been modified by queue, if an optional property is not specified the queue may provide a default value.

See https://docs.taskcluster.net/reference/platform/queue/api-docs#task

type RedirectArtifactRequest 

type RedirectArtifactRequest struct {

	// Artifact mime-type for the resource to which the queue should
	// redirect. Please use the same `Content-Type`, consistently using
	// the correct mime-type make tooling a lot easier, specifically,
	// always using `application/json` for JSON artifacts.
	//
	// Max length: 255
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[2]/properties/contentType
	ContentType string `json:"contentType"`

	// Date-time after which the queue should no longer redirect to this URL.
	// Note, that the queue will and cannot delete the resource your URL
	// references, you are responsible for doing that yourself.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[2]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Artifact storage type, in this case `reference`
	//
	// Possible values:
	//   * "reference"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[2]/properties/storageType
	StorageType string `json:"storageType"`

	// URL to which the queue should redirect using a `303` (See other)
	// redirect.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[2]/properties/url
	URL string `json:"url"`
}

Request the queue to redirect to a URL for a given artifact. This allows you to reference artifacts that aren't managed by the queue. The queue will still authenticate the request, so depending on the level of secrecy required, secret URLs **might** work. Note, this is mainly useful for public artifacts, for example temporary files directly stored on the worker host and only available there for a specific amount of time.

See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[2]

type RedirectArtifactResponse 

type RedirectArtifactResponse struct {

	// Artifact storage type, in this case `reference`
	//
	// Possible values:
	//   * "reference"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[2]/properties/storageType
	StorageType string `json:"storageType"`
}

Response to a request for the queue to redirect to a URL for a given artifact.

See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[2]

type S3ArtifactRequest 

type S3ArtifactRequest struct {

	// Artifact mime-type, when uploading artifact to the signed
	// `PUT` URL returned from this request this must given with the
	//  `ContentType` header. Please, provide correct mime-type,
	//  this make tooling a lot easier, specifically,
	//  always using `application/json` for JSON artifacts.
	//
	// Max length: 255
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[0]/properties/contentType
	ContentType string `json:"contentType"`

	// Date-time after which the artifact should be deleted. Note, that
	// these will be collected over time, and artifacts may remain
	// available after expiration. S3 based artifacts are identified in
	// azure table storage and explicitly deleted on S3 after expiration.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[0]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Artifact storage type, in this case `'s3'`
	//
	// Possible values:
	//   * "s3"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[0]/properties/storageType
	StorageType string `json:"storageType"`
}

Request for a signed PUT URL that will allow you to upload an artifact to an S3 bucket managed by the queue.

See http://schemas.taskcluster.net/queue/v1/post-artifact-request.json#/oneOf[0]

type S3ArtifactResponse 

type S3ArtifactResponse struct {

	// Artifact mime-type, must be specified as header when uploading with
	// the signed `putUrl`.
	//
	// Max length: 255
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[0]/properties/contentType
	ContentType string `json:"contentType"`

	// Date-time after which the signed `putUrl` no longer works
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[0]/properties/expires
	Expires tcclient.Time `json:"expires"`

	// URL to which a `PUT` request can be made to upload the artifact
	// requested. Note, the `Content-Length` must be specified correctly,
	// and the `ContentType` header must be set the value specified below.
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[0]/properties/putUrl
	PutURL string `json:"putUrl"`

	// Artifact storage type, in this case `'s3'`
	//
	// Possible values:
	//   * "s3"
	//
	// See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[0]/properties/storageType
	StorageType string `json:"storageType"`
}

Response to a request for a signed PUT URL that will allow you to upload an artifact to an S3 bucket managed by the queue.

See http://schemas.taskcluster.net/queue/v1/post-artifact-response.json#/oneOf[0]

type TaskClaimRequest 

type TaskClaimRequest struct {

	// Identifier for group that worker claiming the task is a part of.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-request.json#/properties/workerGroup
	WorkerGroup string `json:"workerGroup"`

	// Identifier for worker within the given workerGroup
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-request.json#/properties/workerId
	WorkerID string `json:"workerId"`
}

Request to claim (or reclaim) a task

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

type TaskClaimResponse 

type TaskClaimResponse struct {

	// Temporary credentials granting `task.scopes` and the scope:
	// `queue:claim-task:<taskId>/<runId>` which allows the worker to reclaim
	// the task, upload artifacts and report task resolution.
	//
	// The temporary credentials are set to expire after `takenUntil`. They
	// won't expire exactly at `takenUntil` but shortly after, hence, requests
	// coming close `takenUntil` won't have problems even if there is a little
	// clock drift.
	//
	// Workers should use these credentials when making requests on behalf of
	// a task. This includes requests to create artifacts, reclaiming the task
	// reporting the task `completed`, `failed` or `exception`.
	//
	// Note, a new set of temporary credentials is issued when the worker
	// reclaims the task.
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/credentials
	Credentials struct {

		// The `accessToken` for the temporary credentials.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/credentials/properties/accessToken
		AccessToken string `json:"accessToken"`

		// The `certificate` for the temporary credentials, these are required
		// for the temporary credentials to work.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/credentials/properties/certificate
		Certificate string `json:"certificate"`

		// The `clientId` for the temporary credentials.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/credentials/properties/clientId
		ClientID string `json:"clientId"`
	} `json:"credentials"`

	// `run-id` assigned to this run of the task
	//
	// Mininum:    0
	// Maximum:    1000
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/runId
	RunID int `json:"runId"`

	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/status
	Status TaskStatusStructure `json:"status"`

	// Time at which the run expires and is resolved as `exception`,
	// with reason `claim-expired` if the run haven't been reclaimed.
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/takenUntil
	TakenUntil tcclient.Time `json:"takenUntil"`

	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/task
	Task TaskDefinitionResponse `json:"task"`

	// Identifier for the worker-group within which this run started.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/workerGroup
	WorkerGroup string `json:"workerGroup"`

	// Identifier for the worker executing this run.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-claim-response.json#/properties/workerId
	WorkerID string `json:"workerId"`
}

Response to a successful task claim

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

type TaskDefinitionRequest 

type TaskDefinitionRequest struct {

	// Creation time of task
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/created
	Created tcclient.Time `json:"created"`

	// 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 http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/deadline
	Deadline tcclient.Time `json:"deadline"`

	// List of dependent tasks. These must either be _completed_ or _resolved_
	// before this task is scheduled. See `requires` for semantics.
	//
	// Default:    []
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/dependencies
	Dependencies []string `json:"dependencies,omitempty"`

	// 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 subject to change).
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/expires
	Expires tcclient.Time `json:"expires,omitempty"`

	// 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/create-task-request.json#/properties/extra
	Extra json.RawMessage `json:"extra,omitempty"`

	// Required task metadata
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/metadata
	Metadata struct {

		// Human readable description of the task, please **explain** what the
		// task does. A few lines of documentation is not going to hurt you.
		//
		// Max length: 32768
		//
		// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/metadata/properties/description
		Description string `json:"description"`

		// Human readable name of task, used to very briefly given an idea about
		// what the task does.
		//
		// Max length: 255
		//
		// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/metadata/properties/name
		Name string `json:"name"`

		// E-mail of person who caused this task, e.g. the person who did
		// `hg push`. The person we should contact to ask why this task is here.
		//
		// Max length: 255
		//
		// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/metadata/properties/owner
		Owner string `json:"owner"`

		// Link to source of this task, should specify a file, revision and
		// repository. This should be place someone can go an do a git/hg blame
		// to who came up with recipe for this task.
		//
		// Max length: 4096
		//
		// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/metadata/properties/source
		Source string `json:"source"`
	} `json:"metadata"`

	// 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/create-task-request.json#/properties/payload
	Payload json.RawMessage `json:"payload"`

	// Priority of task, this defaults to `normal`. Additional levels may be
	// added later.
	// **Task submitter required scopes** `queue:task-priority:high` for high
	// priority tasks.
	//
	// Possible values:
	//   * "high"
	//   * "normal"
	//
	// Default:    "normal"
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/priority
	Priority string `json:"priority,omitempty"`

	// 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/create-task-request.json#/properties/provisionerId
	ProvisionerID string `json:"provisionerId"`

	// 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 http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/requires
	Requires string `json:"requires,omitempty"`

	// 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 http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/retries
	Retries int `json:"retries,omitempty"`

	// List of task specific routes, AMQP messages will be CC'ed to these routes.
	// **Task submitter required scopes** `queue:route:<route>` for
	// each route given.
	//
	// Default:    []
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/routes
	Routes []string `json:"routes,omitempty"`

	// Identifier for the scheduler that _defined_ this task, this can be an
	// identifier for a user or a service like the `"task-graph-scheduler"`.
	// **Task submitter required scopes**
	// `queue:assume:scheduler-id:<schedulerId>/<taskGroupId>`.
	// This scope is also necessary to _schedule_ a defined task, or _rerun_ a
	// task.
	//
	// Default:    "-"
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/schedulerId
	SchedulerID string `json:"schedulerId,omitempty"`

	// List of scopes (or scope-patterns) that the task is
	// authorized to use.
	//
	// Default:    []
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/scopes
	Scopes []string `json:"scopes,omitempty"`

	// 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.
	//
	// Default:    map[]
	//
	// See http://schemas.taskcluster.net/queue/v1/create-task-request.json#/properties/tags
	Tags json.RawMessage `json:"tags,omitempty"`

	// 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/create-task-request.json#/properties/taskGroupId
	TaskGroupID string `json:"taskGroupId,omitempty"`

	// 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/create-task-request.json#/properties/workerType
	WorkerType string `json:"workerType"`
}

Definition of a task that can be scheduled

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

type TaskDefinitionResponse 

type TaskDefinitionResponse struct {

	// Creation time of task
	//
	// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/created
	Created tcclient.Time `json:"created"`

	// 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 http://schemas.taskcluster.net/queue/v1/task.json#/properties/deadline
	Deadline tcclient.Time `json:"deadline"`

	// 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
	Dependencies []string `json:"dependencies"`

	// 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 subject to change).
	//
	// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/expires
	Expires tcclient.Time `json:"expires,omitempty"`

	// 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
	Extra json.RawMessage `json:"extra"`

	// Required task metadata
	//
	// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata
	Metadata struct {

		// Human readable description of the task, please **explain** what the
		// task does. A few lines of documentation is not going to hurt you.
		//
		// Max length: 32768
		//
		// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata/properties/description
		Description string `json:"description"`

		// Human readable name of task, used to very briefly given an idea about
		// what the task does.
		//
		// Max length: 255
		//
		// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata/properties/name
		Name string `json:"name"`

		// E-mail of person who caused this task, e.g. the person who did
		// `hg push`. The person we should contact to ask why this task is here.
		//
		// Max length: 255
		//
		// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata/properties/owner
		Owner string `json:"owner"`

		// Link to source of this task, should specify a file, revision and
		// repository. This should be place someone can go an do a git/hg blame
		// to who came up with recipe for this task.
		//
		// Max length: 4096
		//
		// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/metadata/properties/source
		Source string `json:"source"`
	} `json:"metadata"`

	// 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
	Payload json.RawMessage `json:"payload"`

	// 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
	Priority string `json:"priority"`

	// 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
	ProvisionerID string `json:"provisionerId"`

	// 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
	Requires string `json:"requires"`

	// 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
	Retries int `json:"retries"`

	// 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
	Routes []string `json:"routes"`

	// 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
	SchedulerID string `json:"schedulerId"`

	// List of scopes (or scope-patterns) that the task is
	// authorized to use.
	//
	// See http://schemas.taskcluster.net/queue/v1/task.json#/properties/scopes
	Scopes []string `json:"scopes"`

	// 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
	Tags json.RawMessage `json:"tags"`

	// 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
	TaskGroupID string `json:"taskGroupId"`

	// 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
	WorkerType string `json:"workerType"`
}

Definition of a task that can be scheduled

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

type TaskExceptionRequest 

type TaskExceptionRequest struct {

	// Reason that the task is resolved with an exception. This is a subset
	// of the values for `resolvedReason` given in the task status structure.
	// **Report `worker-shutdown`** if the run failed because the worker
	// had to shutdown (spot node disappearing). In case of `worker-shutdown`
	// the queue will immediately **retry** the task, by making a new run.
	// This is much faster than ignoreing the issue and letting the task _retry_
	// by claim expiration. For any other _reason_ reported the queue will not
	// retry the task.
	// **Report `malformed-payload`** if the `task.payload` doesn't match the
	// schema for the worker payload, or referenced resource doesn't exists.
	// In either case, you should still log the error to a log file for the
	// specific run.
	// **Report `resource-unavailable`** if a resource/service needed or
	// referenced in `task.payload` is _temporarily_ unavailable. Do not use this
	// unless you know the resource exists, if the resource doesn't exist you
	// should report `malformed-payload`. Example use-case if you contact the
	// index (a service) on behalf of the task, because of a declaration in
	// `task.payload`, and the service (index) is temporarily down. Don't use
	// this if a URL returns 404, but if it returns 503 or hits a timeout when
	// you retry the request, then this _may_ be a valid exception. The queue
	// assumes that workers have applied retries as needed, and will not retry
	//  the task.
	// **Report `internal-error`** if the worker experienced an unhandled internal
	// error from which it couldn't recover. The queue will not retry runs
	// resolved with this reason, but you are clearly signaling that this is a
	// bug in the worker code.
	// **Report `superseded`** if the task was determined to have been
	// superseded by another task, and its results are no longer needed.  It is
	// convention in this case to create an artifact entitled
	// `public/superseded-by` containing the taskId of the task that superseded
	// this one.
	// **Report `intermittent-task`** if the task explicitely requested a retry
	// because task is intermittent. Workers can choose whether or not to
	// support this, but workers shouldn't blindly report this for every task
	// that fails.
	//
	// Possible values:
	//   * "worker-shutdown"
	//   * "malformed-payload"
	//   * "resource-unavailable"
	//   * "internal-error"
	//   * "superseded"
	//   * "intermittent-task"
	//
	// See http://schemas.taskcluster.net/queue/v1/task-exception-request.json#/properties/reason
	Reason string `json:"reason"`
}

Request for a run of a task to be resolved with an exception

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

type TaskReclaimResponse 

type TaskReclaimResponse struct {

	// Temporary credentials granting `task.scopes` and the scope:
	// `queue:claim-task:<taskId>/<runId>` which allows the worker to reclaim
	// the task, upload artifacts and report task resolution.
	//
	// The temporary credentials are set to expire after `takenUntil`. They
	// won't expire exactly at `takenUntil` but shortly after, hence, requests
	// coming close `takenUntil` won't have problems even if there is a little
	// clock drift.
	//
	// Workers should use these credentials when making requests on behalf of
	// a task. This includes requests to create artifacts, reclaiming the task
	// reporting the task `completed`, `failed` or `exception`.
	//
	// Note, a new set of temporary credentials is issued when the worker
	// reclaims the task.
	//
	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/credentials
	Credentials struct {

		// The `accessToken` for the temporary credentials.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/credentials/properties/accessToken
		AccessToken string `json:"accessToken"`

		// The `certificate` for the temporary credentials, these are required
		// for the temporary credentials to work.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/credentials/properties/certificate
		Certificate string `json:"certificate"`

		// The `clientId` for the temporary credentials.
		//
		// Min length: 1
		//
		// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/credentials/properties/clientId
		ClientID string `json:"clientId"`
	} `json:"credentials"`

	// `run-id` assigned to this run of the task
	//
	// Mininum:    0
	// Maximum:    1000
	//
	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/runId
	RunID int `json:"runId"`

	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/status
	Status TaskStatusStructure `json:"status"`

	// Time at which the run expires and is resolved as `exception`,
	// with reason `claim-expired` if the run haven't been reclaimed.
	//
	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/takenUntil
	TakenUntil tcclient.Time `json:"takenUntil"`

	// Identifier for the worker-group within which this run started.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/workerGroup
	WorkerGroup string `json:"workerGroup"`

	// Identifier for the worker executing this run.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-reclaim-response.json#/properties/workerId
	WorkerID string `json:"workerId"`
}

Response to a successful task claim

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

type TaskStatusResponse 

type TaskStatusResponse struct {

	// See http://schemas.taskcluster.net/queue/v1/task-status-response.json#/properties/status
	Status TaskStatusStructure `json:"status"`
}

Response to a task status request

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

type TaskStatusStructure 

type TaskStatusStructure struct {

	// 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 http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/deadline
	Deadline tcclient.Time `json:"deadline"`

	// 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.
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/expires
	Expires tcclient.Time `json:"expires"`

	// Unique identifier for the provisioner that this task must be scheduled on
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/provisionerId
	ProvisionerID string `json:"provisionerId"`

	// Number of retries left for the task in case of infrastructure issues
	//
	// Mininum:    0
	// Maximum:    999
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/retriesLeft
	RetriesLeft int `json:"retriesLeft"`

	// List of runs, ordered so that index `i` has `runId == i`
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs
	Runs []struct {

		// Reason for the creation of this run,
		// **more reasons may be added in the future**.
		//
		// Possible values:
		//   * "scheduled"
		//   * "retry"
		//   * "task-retry"
		//   * "rerun"
		//   * "exception"
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/reasonCreated
		ReasonCreated string `json:"reasonCreated"`

		// Reason that run was resolved, this is mainly
		// useful for runs resolved as `exception`.
		// Note, **more reasons may be added in the future**, also this
		// property is only available after the run is resolved.
		//
		// Possible values:
		//   * "completed"
		//   * "failed"
		//   * "deadline-exceeded"
		//   * "canceled"
		//   * "superseded"
		//   * "claim-expired"
		//   * "worker-shutdown"
		//   * "malformed-payload"
		//   * "resource-unavailable"
		//   * "internal-error"
		//   * "intermittent-task"
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/reasonResolved
		ReasonResolved string `json:"reasonResolved,omitempty"`

		// Date-time at which this run was resolved, ie. when the run changed
		// state from `running` to either `completed`, `failed` or `exception`.
		// This property is only present after the run as been resolved.
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/resolved
		Resolved tcclient.Time `json:"resolved,omitempty"`

		// Id of this task run, `run-id`s always starts from `0`
		//
		// Mininum:    0
		// Maximum:    1000
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/runId
		RunID int `json:"runId"`

		// Date-time at which this run was scheduled, ie. when the run was
		// created in state `pending`.
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/scheduled
		Scheduled tcclient.Time `json:"scheduled"`

		// Date-time at which this run was claimed, ie. when the run changed
		// state from `pending` to `running`. This property is only present
		// after the run has been claimed.
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/started
		Started tcclient.Time `json:"started,omitempty"`

		// State of this run
		//
		// Possible values:
		//   * "pending"
		//   * "running"
		//   * "completed"
		//   * "failed"
		//   * "exception"
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/state
		State string `json:"state"`

		// Time at which the run expires and is resolved as `failed`, if the
		// run isn't reclaimed. Note, only present after the run has been
		// claimed.
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/takenUntil
		TakenUntil tcclient.Time `json:"takenUntil,omitempty"`

		// Identifier for group that worker who executes this run is a part of,
		// this identifier is mainly used for efficient routing.
		// Note, this property is only present after the run is claimed.
		//
		// Syntax:     ^([a-zA-Z0-9-_]*)$
		// Min length: 1
		// Max length: 22
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/workerGroup
		WorkerGroup string `json:"workerGroup,omitempty"`

		// Identifier for worker evaluating this run within given
		// `workerGroup`. Note, this property is only available after the run
		// has been claimed.
		//
		// Syntax:     ^([a-zA-Z0-9-_]*)$
		// Min length: 1
		// Max length: 22
		//
		// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/runs/items/properties/workerId
		WorkerID string `json:"workerId,omitempty"`
	} `json:"runs"`

	// Identifier for the scheduler that _defined_ this task.
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/schedulerId
	SchedulerID string `json:"schedulerId"`

	// State of this task. This is just an auxiliary property derived from state
	// of latests run, or `unscheduled` if none.
	//
	// Possible values:
	//   * "unscheduled"
	//   * "pending"
	//   * "running"
	//   * "completed"
	//   * "failed"
	//   * "exception"
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/state
	State string `json:"state"`

	// 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`.
	//
	// 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-status.json#/properties/taskGroupId
	TaskGroupID string `json:"taskGroupId"`

	// Unique task identifier, this is UUID encoded as
	// [URL-safe base64](http://tools.ietf.org/html/rfc4648#section-5) and
	// stripped of `=` padding.
	//
	// 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-status.json#/properties/taskId
	TaskID string `json:"taskId"`

	// Identifier for worker type within the specified provisioner
	//
	// Syntax:     ^([a-zA-Z0-9-_]*)$
	// Min length: 1
	// Max length: 22
	//
	// See http://schemas.taskcluster.net/queue/v1/task-status.json#/properties/workerType
	WorkerType string `json:"workerType"`
}

A representation of **task status** as known by the queue

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.