Module: taskcluster-client/queue

taskcluster-client/queue

new require("taskcluster-client/queue")(options)

HTTP api for the taskcluster queue.

Parameters:
Name Type Description
options Object

for the queue.

[options.queueUrl]. String
Source:
See:
Source:

Methods

amqpConnectionString() → {Promise.<Object>}

Fetch the amqp credentials from taskcluster queue and create an amqplib connection.

Source:
Returns:
Type
Promise.<Object>

getTask(taskId) → {Promise.<Object>}

Fetch a task definition based on its task id.

Parameters:
Name Type Description
taskId String

acquired by posting a task.

Source:
Returns:

task definition promise.

Type
Promise.<Object>

postTask(task) → {Promise.<Object>}

Create a new task see the task_factories tutorial for usage with the taskcluster-client/factory/task module for utilities to construct the task body.

Parameters:
Name Type Description
task Object

definition.

Source:
Returns:

promise response.

Type
Promise.<Object>

request(method, url) → {Promise.<Object>}

Issue a request to the taskcluster queue.

Parameters:
Name Type Description
method String

to issue.

url String

for the queue.

Source:
Returns:
Type
Promise.<Object>

url(path, placeholders) → {String}

Build a url for the queue (with the appropriate version). Runs string through util.format so placeholders can be used...

Parameters:
Name Type Argument Description
path String

to use (can use placeholders in string)

placeholders Array <optional>
Source:
Returns:

complete url for the taskcluster queue.

Type
String