@taskcluster/client-web 100.4.0 → 100.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,123 +10,108 @@ export default class Queue extends Client {
10
10
  exchangePrefix: '',
11
11
  ...options,
12
12
  });
13
- this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
14
- this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
15
- this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
16
- this.task.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"task","output":true,"query":[],"route":"/task/<taskId>","scopes":"queue:get-task:<taskId>","stability":"stable","type":"function"}; // eslint-disable-line
17
- this.tasks.entry = {"args":[],"category":"Tasks","input":true,"method":"post","name":"tasks","output":true,"query":["continuationToken","limit"],"route":"/tasks","scopes":{"AllOf":[{"each":"queue:get-task:<taskId>","for":"taskId","in":"taskIds"}]},"stability":"experimental","type":"function"}; // eslint-disable-line
18
- this.statuses.entry = {"args":[],"category":"Tasks","input":true,"method":"post","name":"statuses","output":true,"query":["continuationToken","limit"],"route":"/tasks/status","scopes":{"AllOf":[{"each":"queue:status:<taskId>","for":"taskId","in":"taskIds"}]},"stability":"experimental","type":"function"}; // eslint-disable-line
19
- this.status.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"status","output":true,"query":[],"route":"/task/<taskId>/status","scopes":"queue:status:<taskId>","stability":"stable","type":"function"}; // eslint-disable-line
20
- this.listTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"get","name":"listTaskGroup","output":true,"query":["continuationToken","limit"],"route":"/task-group/<taskGroupId>/list","scopes":"queue:list-task-group:<taskGroupId>","stability":"stable","type":"function"}; // eslint-disable-line
21
- this.cancelTaskGroup.entry = {"args":["taskGroupId"],"category":"Tasks","method":"post","name":"cancelTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>/cancel","scopes":"queue:cancel-task-group:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"}; // eslint-disable-line
22
- this.getTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"get","name":"getTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>","scopes":"queue:list-task-group:<taskGroupId>","stability":"stable","type":"function"}; // eslint-disable-line
23
- this.sealTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"post","name":"sealTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>/seal","scopes":"queue:seal-task-group:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"}; // eslint-disable-line
24
- this.listDependentTasks.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"listDependentTasks","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/dependents","scopes":"queue:list-dependent-tasks:<taskId>","stability":"stable","type":"function"}; // eslint-disable-line
25
- this.createTask.entry = {"args":["taskId"],"category":"Tasks","input":true,"method":"put","name":"createTask","output":true,"query":[],"route":"/task/<taskId>","scopes":{"AllOf":[{"each":"<scope>","for":"scope","in":"scopes"},{"each":"queue:route:<route>","for":"route","in":"routes"},"queue:create-task:project:<projectId>","queue:scheduler-id:<schedulerId>",{"AnyOf":[{"each":"queue:create-task:<priority>:<provisionerId>/<workerType>","for":"priority","in":"priorities"}]}]},"stability":"stable","type":"function"}; // eslint-disable-line
26
- this.scheduleTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"scheduleTask","output":true,"query":[],"route":"/task/<taskId>/schedule","scopes":{"AnyOf":["queue:schedule-task:<schedulerId>/<taskGroupId>/<taskId>","queue:schedule-task-in-project:<projectId>",{"AllOf":["queue:schedule-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"}; // eslint-disable-line
27
- this.rerunTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"rerunTask","output":true,"query":[],"route":"/task/<taskId>/rerun","scopes":{"AnyOf":["queue:rerun-task:<schedulerId>/<taskGroupId>/<taskId>","queue:rerun-task-in-project:<projectId>",{"AllOf":["queue:rerun-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"}; // eslint-disable-line
28
- this.cancelTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"cancelTask","output":true,"query":[],"route":"/task/<taskId>/cancel","scopes":{"AnyOf":["queue:cancel-task:<schedulerId>/<taskGroupId>/<taskId>","queue:cancel-task-in-project:<projectId>",{"AllOf":["queue:cancel-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"}; // eslint-disable-line
29
- this.changeTaskPriority.entry = {"args":["taskId"],"category":"Tasks","input":true,"method":"post","name":"changeTaskPriority","output":true,"query":[],"route":"/task/<taskId>/priority","scopes":{"AnyOf":["queue:change-task-priority:<taskId>","queue:change-task-priority-in-queue:<taskQueueId>"]},"stability":"experimental","type":"function"}; // eslint-disable-line
30
- this.changeTaskGroupPriority.entry = {"args":["taskGroupId"],"category":"Task-Groups","input":true,"method":"post","name":"changeTaskGroupPriority","output":true,"query":[],"route":"/task-group/<taskGroupId>/priority","scopes":"queue:change-task-group-priority:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"}; // eslint-disable-line
31
- this.claimWork.entry = {"args":["taskQueueId"],"category":"Worker Interface","input":true,"method":"post","name":"claimWork","output":true,"query":[],"route":"/claim-work/<taskQueueId>","scopes":{"AllOf":["queue:claim-work:<taskQueueId>","queue:worker-id:<workerGroup>/<workerId>"]},"stability":"stable","type":"function"}; // eslint-disable-line
32
- this.claimTask.entry = {"args":["taskId","runId"],"category":"Worker Interface","input":true,"method":"post","name":"claimTask","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/claim","scopes":{"AllOf":["queue:claim-task:<provisionerId>/<workerType>","queue:worker-id:<workerGroup>/<workerId>"]},"stability":"deprecated","type":"function"}; // eslint-disable-line
33
- this.reclaimTask.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reclaimTask","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/reclaim","scopes":"queue:reclaim-task:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
34
- this.reportCompleted.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reportCompleted","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/completed","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
35
- this.reportFailed.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reportFailed","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/failed","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
36
- this.reportException.entry = {"args":["taskId","runId"],"category":"Worker Interface","input":true,"method":"post","name":"reportException","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/exception","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
37
- this.createArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","input":true,"method":"post","name":"createArtifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":"queue:create-artifact:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
38
- this.finishArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","input":true,"method":"put","name":"finishArtifact","query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":"queue:create-artifact:<taskId>/<runId>","stability":"stable","type":"function"}; // eslint-disable-line
39
- this.getArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"getArtifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"}; // eslint-disable-line
40
- this.getLatestArtifact.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"getLatestArtifact","output":true,"query":[],"route":"/task/<taskId>/artifacts/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"}; // eslint-disable-line
41
- this.listArtifacts.entry = {"args":["taskId","runId"],"category":"Artifacts","method":"get","name":"listArtifacts","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/runs/<runId>/artifacts","scopes":"queue:list-artifacts:<taskId>:<runId>","stability":"stable","type":"function"}; // eslint-disable-line
42
- this.listLatestArtifacts.entry = {"args":["taskId"],"category":"Artifacts","method":"get","name":"listLatestArtifacts","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/artifacts","scopes":"queue:list-artifacts:<taskId>","stability":"stable","type":"function"}; // eslint-disable-line
43
- this.artifactInfo.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"artifactInfo","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifact-info/<name>","scopes":"queue:list-artifacts:<taskId>:<runId>","stability":"stable","type":"function"}; // eslint-disable-line
44
- this.latestArtifactInfo.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"latestArtifactInfo","output":true,"query":[],"route":"/task/<taskId>/artifact-info/<name>","scopes":"queue:list-artifacts:<taskId>","stability":"stable","type":"function"}; // eslint-disable-line
45
- this.artifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"artifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifact-content/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"}; // eslint-disable-line
46
- this.latestArtifact.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"latestArtifact","output":true,"query":[],"route":"/task/<taskId>/artifact-content/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"}; // eslint-disable-line
47
- this.listProvisioners.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listProvisioners","output":true,"query":["continuationToken","limit"],"route":"/provisioners","scopes":"queue:list-provisioners","stability":"deprecated","type":"function"}; // eslint-disable-line
48
- this.getProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"getProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":"queue:get-provisioner:<provisionerId>","stability":"deprecated","type":"function"}; // eslint-disable-line
49
- this.declareProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","input":true,"method":"put","name":"declareProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":{"AllOf":[{"each":"queue:declare-provisioner:<provisionerId>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"}; // eslint-disable-line
50
- this.pendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"pendingTasks","output":true,"query":[],"route":"/pending/<taskQueueId>","scopes":"queue:pending-count:<taskQueueId>","stability":"deprecated","type":"function"}; // eslint-disable-line
51
- this.taskQueueCounts.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"taskQueueCounts","output":true,"query":[],"route":"/task-queues/<taskQueueId>/counts","scopes":{"AllOf":["queue:pending-count:<taskQueueId>","queue:claimed-count:<taskQueueId>"]},"stability":"stable","type":"function"}; // eslint-disable-line
52
- this.listPendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listPendingTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/pending","scopes":"queue:pending-list:<taskQueueId>","stability":"experimental","type":"function"}; // eslint-disable-line
53
- this.listClaimedTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listClaimedTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/claimed","scopes":"queue:claimed-list:<taskQueueId>","stability":"experimental","type":"function"}; // eslint-disable-line
54
- this.listWorkerTypes.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"listWorkerTypes","output":true,"query":["continuationToken","limit"],"route":"/provisioners/<provisionerId>/worker-types","scopes":"queue:list-worker-types:<provisionerId>","stability":"deprecated","type":"function"}; // eslint-disable-line
55
- this.getWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"getWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":"queue:get-worker-type:<provisionerId>/<workerType>","stability":"deprecated","type":"function"}; // eslint-disable-line
56
- this.declareWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","input":true,"method":"put","name":"declareWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":{"AllOf":[{"each":"queue:declare-worker-type:<provisionerId>/<workerType>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"}; // eslint-disable-line
57
- this.listTaskQueues.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listTaskQueues","output":true,"query":["continuationToken","limit"],"route":"/task-queues","scopes":"queue:list-task-queues","stability":"stable","type":"function"}; // eslint-disable-line
58
- this.getTaskQueue.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"getTaskQueue","output":true,"query":[],"route":"/task-queues/<taskQueueId>","scopes":"queue:get-task-queue:<taskQueueId>","stability":"stable","type":"function"}; // eslint-disable-line
59
- this.listWorkers.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"listWorkers","output":true,"query":["continuationToken","limit","quarantined"],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers","scopes":"queue:list-workers:<provisionerId>/<workerType>","stability":"deprecated","type":"function"}; // eslint-disable-line
60
- this.getWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","method":"get","name":"getWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers/<workerGroup>/<workerId>","scopes":"queue:get-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>","stability":"deprecated","type":"function"}; // eslint-disable-line
61
- this.quarantineWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","input":true,"method":"put","name":"quarantineWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers/<workerGroup>/<workerId>","scopes":{"AllOf":["queue:quarantine-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>"]},"stability":"experimental","type":"function"}; // eslint-disable-line
62
- this.declareWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","input":true,"method":"put","name":"declareWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/<workerGroup>/<workerId>","scopes":{"AllOf":[{"each":"queue:declare-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>#<property>","for":"property","in":"properties"}]},"stability":"experimental","type":"function"}; // eslint-disable-line
63
- this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
64
- }
65
- /* eslint-disable max-len */
13
+ this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"};
14
+ this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"};
15
+ this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"};
16
+ this.task.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"task","output":true,"query":[],"route":"/task/<taskId>","scopes":"queue:get-task:<taskId>","stability":"stable","type":"function"};
17
+ this.tasks.entry = {"args":[],"category":"Tasks","input":true,"method":"post","name":"tasks","output":true,"query":["continuationToken","limit"],"route":"/tasks","scopes":{"AllOf":[{"each":"queue:get-task:<taskId>","for":"taskId","in":"taskIds"}]},"stability":"experimental","type":"function"};
18
+ this.statuses.entry = {"args":[],"category":"Tasks","input":true,"method":"post","name":"statuses","output":true,"query":["continuationToken","limit"],"route":"/tasks/status","scopes":{"AllOf":[{"each":"queue:status:<taskId>","for":"taskId","in":"taskIds"}]},"stability":"experimental","type":"function"};
19
+ this.status.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"status","output":true,"query":[],"route":"/task/<taskId>/status","scopes":"queue:status:<taskId>","stability":"stable","type":"function"};
20
+ this.listTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"get","name":"listTaskGroup","output":true,"query":["continuationToken","limit"],"route":"/task-group/<taskGroupId>/list","scopes":"queue:list-task-group:<taskGroupId>","stability":"stable","type":"function"};
21
+ this.cancelTaskGroup.entry = {"args":["taskGroupId"],"category":"Tasks","method":"post","name":"cancelTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>/cancel","scopes":"queue:cancel-task-group:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"};
22
+ this.getTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"get","name":"getTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>","scopes":"queue:list-task-group:<taskGroupId>","stability":"stable","type":"function"};
23
+ this.sealTaskGroup.entry = {"args":["taskGroupId"],"category":"Task Groups","method":"post","name":"sealTaskGroup","output":true,"query":[],"route":"/task-group/<taskGroupId>/seal","scopes":"queue:seal-task-group:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"};
24
+ this.listDependentTasks.entry = {"args":["taskId"],"category":"Tasks","method":"get","name":"listDependentTasks","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/dependents","scopes":"queue:list-dependent-tasks:<taskId>","stability":"stable","type":"function"};
25
+ this.createTask.entry = {"args":["taskId"],"category":"Tasks","input":true,"method":"put","name":"createTask","output":true,"query":[],"route":"/task/<taskId>","scopes":{"AllOf":[{"each":"<scope>","for":"scope","in":"scopes"},{"each":"queue:route:<route>","for":"route","in":"routes"},"queue:create-task:project:<projectId>","queue:scheduler-id:<schedulerId>",{"AnyOf":[{"each":"queue:create-task:<priority>:<provisionerId>/<workerType>","for":"priority","in":"priorities"}]}]},"stability":"stable","type":"function"};
26
+ this.scheduleTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"scheduleTask","output":true,"query":[],"route":"/task/<taskId>/schedule","scopes":{"AnyOf":["queue:schedule-task:<schedulerId>/<taskGroupId>/<taskId>","queue:schedule-task-in-project:<projectId>",{"AllOf":["queue:schedule-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"};
27
+ this.rerunTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"rerunTask","output":true,"query":[],"route":"/task/<taskId>/rerun","scopes":{"AnyOf":["queue:rerun-task:<schedulerId>/<taskGroupId>/<taskId>","queue:rerun-task-in-project:<projectId>",{"AllOf":["queue:rerun-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"};
28
+ this.cancelTask.entry = {"args":["taskId"],"category":"Tasks","method":"post","name":"cancelTask","output":true,"query":[],"route":"/task/<taskId>/cancel","scopes":{"AnyOf":["queue:cancel-task:<schedulerId>/<taskGroupId>/<taskId>","queue:cancel-task-in-project:<projectId>",{"AllOf":["queue:cancel-task","assume:scheduler-id:<schedulerId>/<taskGroupId>"]}]},"stability":"stable","type":"function"};
29
+ this.changeTaskPriority.entry = {"args":["taskId"],"category":"Tasks","input":true,"method":"post","name":"changeTaskPriority","output":true,"query":[],"route":"/task/<taskId>/priority","scopes":{"AnyOf":["queue:change-task-priority:<taskId>","queue:change-task-priority-in-queue:<taskQueueId>"]},"stability":"experimental","type":"function"};
30
+ this.changeTaskGroupPriority.entry = {"args":["taskGroupId"],"category":"Task-Groups","input":true,"method":"post","name":"changeTaskGroupPriority","output":true,"query":[],"route":"/task-group/<taskGroupId>/priority","scopes":"queue:change-task-group-priority:<schedulerId>/<taskGroupId>","stability":"experimental","type":"function"};
31
+ this.claimWork.entry = {"args":["taskQueueId"],"category":"Worker Interface","input":true,"method":"post","name":"claimWork","output":true,"query":[],"route":"/claim-work/<taskQueueId>","scopes":{"AllOf":["queue:claim-work:<taskQueueId>","queue:worker-id:<workerGroup>/<workerId>"]},"stability":"stable","type":"function"};
32
+ this.claimTask.entry = {"args":["taskId","runId"],"category":"Worker Interface","input":true,"method":"post","name":"claimTask","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/claim","scopes":{"AllOf":["queue:claim-task:<provisionerId>/<workerType>","queue:worker-id:<workerGroup>/<workerId>"]},"stability":"deprecated","type":"function"};
33
+ this.reclaimTask.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reclaimTask","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/reclaim","scopes":"queue:reclaim-task:<taskId>/<runId>","stability":"stable","type":"function"};
34
+ this.reportCompleted.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reportCompleted","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/completed","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"};
35
+ this.reportFailed.entry = {"args":["taskId","runId"],"category":"Worker Interface","method":"post","name":"reportFailed","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/failed","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"};
36
+ this.reportException.entry = {"args":["taskId","runId"],"category":"Worker Interface","input":true,"method":"post","name":"reportException","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/exception","scopes":"queue:resolve-task:<taskId>/<runId>","stability":"stable","type":"function"};
37
+ this.createArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","input":true,"method":"post","name":"createArtifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":"queue:create-artifact:<taskId>/<runId>","stability":"stable","type":"function"};
38
+ this.finishArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","input":true,"method":"put","name":"finishArtifact","query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":"queue:create-artifact:<taskId>/<runId>","stability":"stable","type":"function"};
39
+ this.getArtifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"getArtifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifacts/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"};
40
+ this.getLatestArtifact.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"getLatestArtifact","output":true,"query":[],"route":"/task/<taskId>/artifacts/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"};
41
+ this.listArtifacts.entry = {"args":["taskId","runId"],"category":"Artifacts","method":"get","name":"listArtifacts","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/runs/<runId>/artifacts","scopes":"queue:list-artifacts:<taskId>:<runId>","stability":"stable","type":"function"};
42
+ this.listLatestArtifacts.entry = {"args":["taskId"],"category":"Artifacts","method":"get","name":"listLatestArtifacts","output":true,"query":["continuationToken","limit"],"route":"/task/<taskId>/artifacts","scopes":"queue:list-artifacts:<taskId>","stability":"stable","type":"function"};
43
+ this.artifactInfo.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"artifactInfo","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifact-info/<name>","scopes":"queue:list-artifacts:<taskId>:<runId>","stability":"stable","type":"function"};
44
+ this.latestArtifactInfo.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"latestArtifactInfo","output":true,"query":[],"route":"/task/<taskId>/artifact-info/<name>","scopes":"queue:list-artifacts:<taskId>","stability":"stable","type":"function"};
45
+ this.artifact.entry = {"args":["taskId","runId","name"],"category":"Artifacts","method":"get","name":"artifact","output":true,"query":[],"route":"/task/<taskId>/runs/<runId>/artifact-content/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"};
46
+ this.latestArtifact.entry = {"args":["taskId","name"],"category":"Artifacts","method":"get","name":"latestArtifact","output":true,"query":[],"route":"/task/<taskId>/artifact-content/<name>","scopes":{"AllOf":[{"each":"queue:get-artifact:<name>","for":"name","in":"names"}]},"stability":"stable","type":"function"};
47
+ this.listProvisioners.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listProvisioners","output":true,"query":["continuationToken","limit"],"route":"/provisioners","scopes":"queue:list-provisioners","stability":"deprecated","type":"function"};
48
+ this.getProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"getProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":"queue:get-provisioner:<provisionerId>","stability":"deprecated","type":"function"};
49
+ this.declareProvisioner.entry = {"args":["provisionerId"],"category":"Worker Metadata","input":true,"method":"put","name":"declareProvisioner","output":true,"query":[],"route":"/provisioners/<provisionerId>","scopes":{"AllOf":[{"each":"queue:declare-provisioner:<provisionerId>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"};
50
+ this.pendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"pendingTasks","output":true,"query":[],"route":"/pending/<taskQueueId>","scopes":"queue:pending-count:<taskQueueId>","stability":"deprecated","type":"function"};
51
+ this.taskQueueCounts.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"taskQueueCounts","output":true,"query":[],"route":"/task-queues/<taskQueueId>/counts","scopes":{"AllOf":["queue:pending-count:<taskQueueId>","queue:claimed-count:<taskQueueId>"]},"stability":"stable","type":"function"};
52
+ this.listPendingTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listPendingTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/pending","scopes":"queue:pending-list:<taskQueueId>","stability":"experimental","type":"function"};
53
+ this.listClaimedTasks.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"listClaimedTasks","output":true,"query":["continuationToken","limit"],"route":"/task-queues/<taskQueueId>/claimed","scopes":"queue:claimed-list:<taskQueueId>","stability":"experimental","type":"function"};
54
+ this.listWorkerTypes.entry = {"args":["provisionerId"],"category":"Worker Metadata","method":"get","name":"listWorkerTypes","output":true,"query":["continuationToken","limit"],"route":"/provisioners/<provisionerId>/worker-types","scopes":"queue:list-worker-types:<provisionerId>","stability":"deprecated","type":"function"};
55
+ this.getWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"getWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":"queue:get-worker-type:<provisionerId>/<workerType>","stability":"deprecated","type":"function"};
56
+ this.declareWorkerType.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","input":true,"method":"put","name":"declareWorkerType","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>","scopes":{"AllOf":[{"each":"queue:declare-worker-type:<provisionerId>/<workerType>#<property>","for":"property","in":"properties"}]},"stability":"deprecated","type":"function"};
57
+ this.listTaskQueues.entry = {"args":[],"category":"Worker Metadata","method":"get","name":"listTaskQueues","output":true,"query":["continuationToken","limit"],"route":"/task-queues","scopes":"queue:list-task-queues","stability":"stable","type":"function"};
58
+ this.getTaskQueue.entry = {"args":["taskQueueId"],"category":"Worker Metadata","method":"get","name":"getTaskQueue","output":true,"query":[],"route":"/task-queues/<taskQueueId>","scopes":"queue:get-task-queue:<taskQueueId>","stability":"stable","type":"function"};
59
+ this.listWorkers.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"listWorkers","output":true,"query":["continuationToken","limit","quarantined"],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers","scopes":"queue:list-workers:<provisionerId>/<workerType>","stability":"deprecated","type":"function"};
60
+ this.getWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","method":"get","name":"getWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers/<workerGroup>/<workerId>","scopes":"queue:get-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>","stability":"deprecated","type":"function"};
61
+ this.quarantineWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","input":true,"method":"put","name":"quarantineWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers/<workerGroup>/<workerId>","scopes":{"AllOf":["queue:quarantine-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>"]},"stability":"experimental","type":"function"};
62
+ this.declareWorker.entry = {"args":["provisionerId","workerType","workerGroup","workerId"],"category":"Worker Metadata","input":true,"method":"put","name":"declareWorker","output":true,"query":[],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/<workerGroup>/<workerId>","scopes":{"AllOf":[{"each":"queue:declare-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>#<property>","for":"property","in":"properties"}]},"stability":"experimental","type":"function"};
63
+ this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"};
64
+ }
66
65
  // Respond without doing anything.
67
66
  // This endpoint is used to check that the service is up.
68
- /* eslint-enable max-len */
69
67
  ping(...args) {
70
68
  this.validate(this.ping.entry, args);
71
69
 
72
70
  return this.request(this.ping.entry, args);
73
71
  }
74
- /* eslint-disable max-len */
75
72
  // Respond without doing anything.
76
73
  // This endpoint is used to check that the service is up.
77
- /* eslint-enable max-len */
78
74
  lbheartbeat(...args) {
79
75
  this.validate(this.lbheartbeat.entry, args);
80
76
 
81
77
  return this.request(this.lbheartbeat.entry, args);
82
78
  }
83
- /* eslint-disable max-len */
84
79
  // Respond with the JSON version object.
85
80
  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
86
- /* eslint-enable max-len */
87
81
  version(...args) {
88
82
  this.validate(this.version.entry, args);
89
83
 
90
84
  return this.request(this.version.entry, args);
91
85
  }
92
- /* eslint-disable max-len */
93
86
  // This end-point will return the task-definition. Notice that the task
94
87
  // definition may have been modified by queue, if an optional property is
95
88
  // not specified the queue may provide a default value.
96
- /* eslint-enable max-len */
97
89
  task(...args) {
98
90
  this.validate(this.task.entry, args);
99
91
 
100
92
  return this.request(this.task.entry, args);
101
93
  }
102
- /* eslint-disable max-len */
103
94
  // This end-point will return the task definition for each input task id.
104
95
  // Notice that the task definitions may have been modified by queue.
105
- /* eslint-enable max-len */
106
96
  tasks(...args) {
107
97
  this.validate(this.tasks.entry, args);
108
98
 
109
99
  return this.request(this.tasks.entry, args);
110
100
  }
111
- /* eslint-disable max-len */
112
101
  // This end-point will return the task statuses for each input task id.
113
102
  // If a given taskId does not match a task, it will be ignored,
114
103
  // and callers will need to handle the difference.
115
- /* eslint-enable max-len */
116
104
  statuses(...args) {
117
105
  this.validate(this.statuses.entry, args);
118
106
 
119
107
  return this.request(this.statuses.entry, args);
120
108
  }
121
- /* eslint-disable max-len */
122
109
  // Get task status structure from `taskId`
123
- /* eslint-enable max-len */
124
110
  status(...args) {
125
111
  this.validate(this.status.entry, args);
126
112
 
127
113
  return this.request(this.status.entry, args);
128
114
  }
129
- /* eslint-disable max-len */
130
115
  // List tasks sharing the same `taskGroupId`.
131
116
  // As a task-group may contain an unbounded number of tasks, this end-point
132
117
  // may return a `continuationToken`. To continue listing tasks you must call
@@ -142,13 +127,11 @@ export default class Queue extends Client {
142
127
  // use the query-string option `limit` to return fewer.
143
128
  // If you only want to to fetch task group metadata without the tasks,
144
129
  // you can call the `getTaskGroup` method.
145
- /* eslint-enable max-len */
146
130
  listTaskGroup(...args) {
147
131
  this.validate(this.listTaskGroup.entry, args);
148
132
 
149
133
  return this.request(this.listTaskGroup.entry, args);
150
134
  }
151
- /* eslint-disable max-len */
152
135
  // This method will cancel all unresolved tasks (`unscheduled`, `pending` or `running` states)
153
136
  // with the given `taskGroupId`. Behaviour is similar to the `cancelTask` method.
154
137
  // It is only possible to cancel a task group if it has been sealed using `sealTaskGroup`.
@@ -156,35 +139,29 @@ export default class Queue extends Client {
156
139
  // It is possible to rerun a canceled task which will result in a new run.
157
140
  // Calling `cancelTaskGroup` again in this case will only cancel the new run.
158
141
  // Other tasks that were already canceled would not be canceled again.
159
- /* eslint-enable max-len */
160
142
  cancelTaskGroup(...args) {
161
143
  this.validate(this.cancelTaskGroup.entry, args);
162
144
 
163
145
  return this.request(this.cancelTaskGroup.entry, args);
164
146
  }
165
- /* eslint-disable max-len */
166
147
  // Get task group information by `taskGroupId`.
167
148
  // This will return meta-information associated with the task group.
168
149
  // It contains information about task group expiry date or if it is sealed.
169
150
  // If you also want to see which tasks belong to this task group, you can call
170
151
  // `listTaskGroup` method.
171
- /* eslint-enable max-len */
172
152
  getTaskGroup(...args) {
173
153
  this.validate(this.getTaskGroup.entry, args);
174
154
 
175
155
  return this.request(this.getTaskGroup.entry, args);
176
156
  }
177
- /* eslint-disable max-len */
178
157
  // Seal task group to prevent creation of new tasks.
179
158
  // Task group can be sealed once and is irreversible. Calling it multiple times
180
159
  // will return same result and will not update it again.
181
- /* eslint-enable max-len */
182
160
  sealTaskGroup(...args) {
183
161
  this.validate(this.sealTaskGroup.entry, args);
184
162
 
185
163
  return this.request(this.sealTaskGroup.entry, args);
186
164
  }
187
- /* eslint-disable max-len */
188
165
  // List tasks that depend on the given `taskId`.
189
166
  // As many tasks from different task-groups may dependent on a single tasks,
190
167
  // this end-point may return a `continuationToken`. To continue listing
@@ -198,13 +175,11 @@ export default class Queue extends Client {
198
175
  // you get a result without a `continuationToken`.
199
176
  // If you are not interested in listing all the tasks at once, you may
200
177
  // use the query-string option `limit` to return fewer.
201
- /* eslint-enable max-len */
202
178
  listDependentTasks(...args) {
203
179
  this.validate(this.listDependentTasks.entry, args);
204
180
 
205
181
  return this.request(this.listDependentTasks.entry, args);
206
182
  }
207
- /* eslint-disable max-len */
208
183
  // Create a new task, this is an **idempotent** operation, so repeat it if
209
184
  // you get an internal server error or network connection is dropped.
210
185
  // **Task `deadline`**: the deadline property can be no more than 5 days
@@ -229,13 +204,11 @@ export default class Queue extends Client {
229
204
  // If the task group was sealed, this end-point will return `409` reporting
230
205
  // `RequestConflict` to indicate that it is no longer possible to add new tasks
231
206
  // for this `taskGroupId`.
232
- /* eslint-enable max-len */
233
207
  createTask(...args) {
234
208
  this.validate(this.createTask.entry, args);
235
209
 
236
210
  return this.request(this.createTask.entry, args);
237
211
  }
238
- /* eslint-disable max-len */
239
212
  // scheduleTask will schedule a task to be executed, even if it has
240
213
  // unresolved dependencies. A task would otherwise only be scheduled if
241
214
  // its dependencies were resolved.
@@ -247,13 +220,11 @@ export default class Queue extends Client {
247
220
  // **Note** this operation is **idempotent** and will not fail or complain
248
221
  // if called with a `taskId` that is already scheduled, or even resolved.
249
222
  // To reschedule a task previously resolved, use `rerunTask`.
250
- /* eslint-enable max-len */
251
223
  scheduleTask(...args) {
252
224
  this.validate(this.scheduleTask.entry, args);
253
225
 
254
226
  return this.request(this.scheduleTask.entry, args);
255
227
  }
256
- /* eslint-disable max-len */
257
228
  // This method _reruns_ a previously resolved task, even if it was
258
229
  // _completed_. This is useful if your task completes unsuccessfully, and
259
230
  // you just want to run it from scratch again. This will also reset the
@@ -264,13 +235,11 @@ export default class Queue extends Client {
264
235
  // because a spot node died.
265
236
  // **Remark** this operation is idempotent: if it is invoked for a task that
266
237
  // is `pending` or `running`, it will just return the current task status.
267
- /* eslint-enable max-len */
268
238
  rerunTask(...args) {
269
239
  this.validate(this.rerunTask.entry, args);
270
240
 
271
241
  return this.request(this.rerunTask.entry, args);
272
242
  }
273
- /* eslint-disable max-len */
274
243
  // This method will cancel a task that is either `unscheduled`, `pending` or
275
244
  // `running`. It will resolve the current run as `exception` with
276
245
  // `reasonResolved` set to `canceled`. If the task isn't scheduled yet, ie.
@@ -282,34 +251,28 @@ export default class Queue extends Client {
282
251
  // **Remark** this operation is idempotent, if you try to cancel a task that
283
252
  // isn't `unscheduled`, `pending` or `running`, this operation will just
284
253
  // return the current task status.
285
- /* eslint-enable max-len */
286
254
  cancelTask(...args) {
287
255
  this.validate(this.cancelTask.entry, args);
288
256
 
289
257
  return this.request(this.cancelTask.entry, args);
290
258
  }
291
- /* eslint-disable max-len */
292
259
  // This method updates the priority of a single unresolved task.
293
260
  // * Claimed or running tasks keep their current run priority until they are retried.
294
261
  // * Emits `taskPriorityChanged` events so downstream tooling can observe manual overrides.
295
- /* eslint-enable max-len */
296
262
  changeTaskPriority(...args) {
297
263
  this.validate(this.changeTaskPriority.entry, args);
298
264
 
299
265
  return this.request(this.changeTaskPriority.entry, args);
300
266
  }
301
- /* eslint-disable max-len */
302
267
  // This method applies a new priority to unresolved tasks within a task group.
303
268
  // * Updates run in bounded batches to avoid long locks.
304
269
  // * Claimed or running tasks keep their current run priority until they are retried.
305
270
  // * Emits `taskGroupPriorityChanged` summary event at the end.
306
- /* eslint-enable max-len */
307
271
  changeTaskGroupPriority(...args) {
308
272
  this.validate(this.changeTaskGroupPriority.entry, args);
309
273
 
310
274
  return this.request(this.changeTaskGroupPriority.entry, args);
311
275
  }
312
- /* eslint-disable max-len */
313
276
  // Claim pending task(s) for the given task queue.
314
277
  // If any work is available (even if fewer than the requested number of
315
278
  // tasks, this will return immediately. Otherwise, it will block for tens of
@@ -317,21 +280,17 @@ export default class Queue extends Client {
317
280
  // list of tasks. Callers should sleep a short while (to avoid denial of
318
281
  // service in an error condition) and call the endpoint again. This is a
319
282
  // simple implementation of "long polling".
320
- /* eslint-enable max-len */
321
283
  claimWork(...args) {
322
284
  this.validate(this.claimWork.entry, args);
323
285
 
324
286
  return this.request(this.claimWork.entry, args);
325
287
  }
326
- /* eslint-disable max-len */
327
288
  // claim a task - never documented
328
- /* eslint-enable max-len */
329
289
  claimTask(...args) {
330
290
  this.validate(this.claimTask.entry, args);
331
291
 
332
292
  return this.request(this.claimTask.entry, args);
333
293
  }
334
- /* eslint-disable max-len */
335
294
  // Refresh the claim for a specific `runId` for given `taskId`. This updates
336
295
  // the `takenUntil` property and returns a new set of temporary credentials
337
296
  // for performing requests on behalf of the task. These credentials should
@@ -350,34 +309,28 @@ export default class Queue extends Client {
350
309
  // or the `task.deadline` have been exceeded. If reclaiming fails, workers
351
310
  // should abort the task and forget about the given `runId`. There is no
352
311
  // need to resolve the run or upload artifacts.
353
- /* eslint-enable max-len */
354
312
  reclaimTask(...args) {
355
313
  this.validate(this.reclaimTask.entry, args);
356
314
 
357
315
  return this.request(this.reclaimTask.entry, args);
358
316
  }
359
- /* eslint-disable max-len */
360
317
  // Report a task completed, resolving the run as `completed`.
361
- /* eslint-enable max-len */
362
318
  reportCompleted(...args) {
363
319
  this.validate(this.reportCompleted.entry, args);
364
320
 
365
321
  return this.request(this.reportCompleted.entry, args);
366
322
  }
367
- /* eslint-disable max-len */
368
323
  // Report a run failed, resolving the run as `failed`. Use this to resolve
369
324
  // a run that failed because the task specific code behaved unexpectedly.
370
325
  // For example the task exited non-zero, or didn't produce expected output.
371
326
  // Do not use this if the task couldn't be run because if malformed
372
327
  // payload, or other unexpected condition. In these cases we have a task
373
328
  // exception, which should be reported with `reportException`.
374
- /* eslint-enable max-len */
375
329
  reportFailed(...args) {
376
330
  this.validate(this.reportFailed.entry, args);
377
331
 
378
332
  return this.request(this.reportFailed.entry, args);
379
333
  }
380
- /* eslint-disable max-len */
381
334
  // Resolve a run as _exception_. Generally, you will want to report tasks as
382
335
  // failed instead of exception. You should `reportException` if,
383
336
  // * The `task.payload` is invalid,
@@ -389,13 +342,11 @@ export default class Queue extends Client {
389
342
  // Do not use this to signal that some user-specified code crashed for any
390
343
  // reason specific to this code. If user-specific code hits a resource that
391
344
  // is temporarily unavailable worker should report task _failed_.
392
- /* eslint-enable max-len */
393
345
  reportException(...args) {
394
346
  this.validate(this.reportException.entry, args);
395
347
 
396
348
  return this.request(this.reportException.entry, args);
397
349
  }
398
- /* eslint-disable max-len */
399
350
  // This API end-point creates an artifact for a specific run of a task. This
400
351
  // should **only** be used by a worker currently operating on this task, or
401
352
  // from a process running within the task (ie. on the worker).
@@ -404,13 +355,11 @@ export default class Queue extends Client {
404
355
  // expiration point. This feature makes it feasible to upload large
405
356
  // intermediate artifacts from data processing applications, as the
406
357
  // artifacts can be set to expire a few days later.
407
- /* eslint-enable max-len */
408
358
  createArtifact(...args) {
409
359
  this.validate(this.createArtifact.entry, args);
410
360
 
411
361
  return this.request(this.createArtifact.entry, args);
412
362
  }
413
- /* eslint-disable max-len */
414
363
  // This endpoint marks an artifact as present for the given task, and
415
364
  // should be called when the artifact data is fully uploaded.
416
365
  // The storage types `reference`, `link`, and `error` do not need to
@@ -418,13 +367,11 @@ export default class Queue extends Client {
418
367
  // The storage type `s3` does not support this functionality and cannot
419
368
  // be finished. In all such cases, calling this method is an input error
420
369
  // (400).
421
- /* eslint-enable max-len */
422
370
  finishArtifact(...args) {
423
371
  this.validate(this.finishArtifact.entry, args);
424
372
 
425
373
  return this.request(this.finishArtifact.entry, args);
426
374
  }
427
- /* eslint-disable max-len */
428
375
  // Get artifact by `<name>` from a specific run.
429
376
  // **Artifact Access**, in order to get an artifact you need the scope
430
377
  // `queue:get-artifact:<name>`, where `<name>` is the name of the artifact.
@@ -467,13 +414,11 @@ export default class Queue extends Client {
467
414
  // The following important headers are set on the response to this method:
468
415
  // * location: the url of the artifact if a redirect is to be performed
469
416
  // * x-taskcluster-artifact-storage-type: the storage type. Example: s3
470
- /* eslint-enable max-len */
471
417
  getArtifact(...args) {
472
418
  this.validate(this.getArtifact.entry, args);
473
419
 
474
420
  return this.request(this.getArtifact.entry, args);
475
421
  }
476
- /* eslint-disable max-len */
477
422
  // Get artifact by `<name>` from the last run of a task.
478
423
  // **Artifact Access**, in order to get an artifact you need the scope
479
424
  // `queue:get-artifact:<name>`, where `<name>` is the name of the artifact.
@@ -519,13 +464,11 @@ export default class Queue extends Client {
519
464
  // **Remark**, this end-point is slightly slower than
520
465
  // `queue.getArtifact`, so consider that if you already know the `runId` of
521
466
  // the latest run. Otherwise, just use the most convenient API end-point.
522
- /* eslint-enable max-len */
523
467
  getLatestArtifact(...args) {
524
468
  this.validate(this.getLatestArtifact.entry, args);
525
469
 
526
470
  return this.request(this.getLatestArtifact.entry, args);
527
471
  }
528
- /* eslint-disable max-len */
529
472
  // Returns a list of artifacts and associated meta-data for a given run.
530
473
  // As a task may have many artifacts paging may be necessary. If this
531
474
  // end-point returns a `continuationToken`, you should call the end-point
@@ -533,13 +476,11 @@ export default class Queue extends Client {
533
476
  // `continuationToken`.
534
477
  // By default this end-point will list up-to 1000 artifacts in a single page
535
478
  // you may limit this with the query-string parameter `limit`.
536
- /* eslint-enable max-len */
537
479
  listArtifacts(...args) {
538
480
  this.validate(this.listArtifacts.entry, args);
539
481
 
540
482
  return this.request(this.listArtifacts.entry, args);
541
483
  }
542
- /* eslint-disable max-len */
543
484
  // Returns a list of artifacts and associated meta-data for the latest run
544
485
  // from the given task.
545
486
  // As a task may have many artifacts paging may be necessary. If this
@@ -548,59 +489,49 @@ export default class Queue extends Client {
548
489
  // `continuationToken`.
549
490
  // By default this end-point will list up-to 1000 artifacts in a single page
550
491
  // you may limit this with the query-string parameter `limit`.
551
- /* eslint-enable max-len */
552
492
  listLatestArtifacts(...args) {
553
493
  this.validate(this.listLatestArtifacts.entry, args);
554
494
 
555
495
  return this.request(this.listLatestArtifacts.entry, args);
556
496
  }
557
- /* eslint-disable max-len */
558
497
  // Returns associated metadata for a given artifact, in the given task run.
559
498
  // The metadata is the same as that returned from `listArtifacts`, and does
560
499
  // not grant access to the artifact data.
561
500
  // Note that this method does *not* automatically follow link artifacts.
562
- /* eslint-enable max-len */
563
501
  artifactInfo(...args) {
564
502
  this.validate(this.artifactInfo.entry, args);
565
503
 
566
504
  return this.request(this.artifactInfo.entry, args);
567
505
  }
568
- /* eslint-disable max-len */
569
506
  // Returns associated metadata for a given artifact, in the latest run of the
570
507
  // task. The metadata is the same as that returned from `listArtifacts`,
571
508
  // and does not grant access to the artifact data.
572
509
  // Note that this method does *not* automatically follow link artifacts.
573
- /* eslint-enable max-len */
574
510
  latestArtifactInfo(...args) {
575
511
  this.validate(this.latestArtifactInfo.entry, args);
576
512
 
577
513
  return this.request(this.latestArtifactInfo.entry, args);
578
514
  }
579
- /* eslint-disable max-len */
580
515
  // Returns information about the content of the artifact, in the given task run.
581
516
  // Depending on the storage type, the endpoint returns the content of the artifact
582
517
  // or enough information to access that content.
583
518
  // This method follows link artifacts, so it will not return content
584
519
  // for a link artifact.
585
- /* eslint-enable max-len */
586
520
  artifact(...args) {
587
521
  this.validate(this.artifact.entry, args);
588
522
 
589
523
  return this.request(this.artifact.entry, args);
590
524
  }
591
- /* eslint-disable max-len */
592
525
  // Returns information about the content of the artifact, in the latest task run.
593
526
  // Depending on the storage type, the endpoint returns the content of the artifact
594
527
  // or enough information to access that content.
595
528
  // This method follows link artifacts, so it will not return content
596
529
  // for a link artifact.
597
- /* eslint-enable max-len */
598
530
  latestArtifact(...args) {
599
531
  this.validate(this.latestArtifact.entry, args);
600
532
 
601
533
  return this.request(this.latestArtifact.entry, args);
602
534
  }
603
- /* eslint-disable max-len */
604
535
  // Get all active provisioners.
605
536
  // The term "provisioner" is taken broadly to mean anything with a provisionerId.
606
537
  // This does not necessarily mean there is an associated service performing any
@@ -609,24 +540,20 @@ export default class Queue extends Client {
609
540
  // should call the end-point again with the `continuationToken` as a query-string
610
541
  // option. By default this end-point will list up to 1000 provisioners in a single
611
542
  // page. You may limit this with the query-string parameter `limit`.
612
- /* eslint-enable max-len */
613
543
  listProvisioners(...args) {
614
544
  this.validate(this.listProvisioners.entry, args);
615
545
 
616
546
  return this.request(this.listProvisioners.entry, args);
617
547
  }
618
- /* eslint-disable max-len */
619
548
  // Get an active provisioner.
620
549
  // The term "provisioner" is taken broadly to mean anything with a provisionerId.
621
550
  // This does not necessarily mean there is an associated service performing any
622
551
  // provisioning activity.
623
- /* eslint-enable max-len */
624
552
  getProvisioner(...args) {
625
553
  this.validate(this.getProvisioner.entry, args);
626
554
 
627
555
  return this.request(this.getProvisioner.entry, args);
628
556
  }
629
- /* eslint-disable max-len */
630
557
  // Declare a provisioner, supplying some details about it.
631
558
  // `declareProvisioner` allows updating one or more properties of a provisioner as long as the required scopes are
632
559
  // possessed. For example, a request to update the `my-provisioner`
@@ -635,106 +562,86 @@ export default class Queue extends Client {
635
562
  // The term "provisioner" is taken broadly to mean anything with a provisionerId.
636
563
  // This does not necessarily mean there is an associated service performing any
637
564
  // provisioning activity.
638
- /* eslint-enable max-len */
639
565
  declareProvisioner(...args) {
640
566
  this.validate(this.declareProvisioner.entry, args);
641
567
 
642
568
  return this.request(this.declareProvisioner.entry, args);
643
569
  }
644
- /* eslint-disable max-len */
645
570
  // Get an approximate number of pending tasks for the given `taskQueueId`.
646
571
  // As task states may change rapidly, this number may not represent the exact
647
572
  // number of pending tasks, but a very good approximation.
648
573
  // This method is **deprecated**, use queue.taskQueueCounts instead.
649
- /* eslint-enable max-len */
650
574
  pendingTasks(...args) {
651
575
  this.validate(this.pendingTasks.entry, args);
652
576
 
653
577
  return this.request(this.pendingTasks.entry, args);
654
578
  }
655
- /* eslint-disable max-len */
656
579
  // Get an approximate number of pending and claimed tasks for the given `taskQueueId`.
657
580
  // As task states may change rapidly, this number may not represent the exact
658
581
  // number of pending and claimed tasks, but a very good approximation.
659
- /* eslint-enable max-len */
660
582
  taskQueueCounts(...args) {
661
583
  this.validate(this.taskQueueCounts.entry, args);
662
584
 
663
585
  return this.request(this.taskQueueCounts.entry, args);
664
586
  }
665
- /* eslint-disable max-len */
666
587
  // List pending tasks for the given `taskQueueId`.
667
588
  // As task states may change rapidly, this information might not represent the exact
668
589
  // state of such tasks, but a very good approximation.
669
- /* eslint-enable max-len */
670
590
  listPendingTasks(...args) {
671
591
  this.validate(this.listPendingTasks.entry, args);
672
592
 
673
593
  return this.request(this.listPendingTasks.entry, args);
674
594
  }
675
- /* eslint-disable max-len */
676
595
  // List claimed tasks for the given `taskQueueId`.
677
596
  // As task states may change rapidly, this information might not represent the exact
678
597
  // state of such tasks, but a very good approximation.
679
- /* eslint-enable max-len */
680
598
  listClaimedTasks(...args) {
681
599
  this.validate(this.listClaimedTasks.entry, args);
682
600
 
683
601
  return this.request(this.listClaimedTasks.entry, args);
684
602
  }
685
- /* eslint-disable max-len */
686
603
  // Get all active worker-types for the given provisioner.
687
604
  // The response is paged. If this end-point returns a `continuationToken`, you
688
605
  // should call the end-point again with the `continuationToken` as a query-string
689
606
  // option. By default this end-point will list up to 1000 worker-types in a single
690
607
  // page. You may limit this with the query-string parameter `limit`.
691
- /* eslint-enable max-len */
692
608
  listWorkerTypes(...args) {
693
609
  this.validate(this.listWorkerTypes.entry, args);
694
610
 
695
611
  return this.request(this.listWorkerTypes.entry, args);
696
612
  }
697
- /* eslint-disable max-len */
698
613
  // Get a worker-type from a provisioner.
699
- /* eslint-enable max-len */
700
614
  getWorkerType(...args) {
701
615
  this.validate(this.getWorkerType.entry, args);
702
616
 
703
617
  return this.request(this.getWorkerType.entry, args);
704
618
  }
705
- /* eslint-disable max-len */
706
619
  // Declare a workerType, supplying some details about it.
707
620
  // `declareWorkerType` allows updating one or more properties of a worker-type as long as the required scopes are
708
621
  // possessed. For example, a request to update the `highmem` worker-type within the `my-provisioner`
709
622
  // provisioner with a body `{description: 'This worker type is great'}` would require you to have the scope
710
623
  // `queue:declare-worker-type:my-provisioner/highmem#description`.
711
- /* eslint-enable max-len */
712
624
  declareWorkerType(...args) {
713
625
  this.validate(this.declareWorkerType.entry, args);
714
626
 
715
627
  return this.request(this.declareWorkerType.entry, args);
716
628
  }
717
- /* eslint-disable max-len */
718
629
  // Get all active task queues.
719
630
  // The response is paged. If this end-point returns a `continuationToken`, you
720
631
  // should call the end-point again with the `continuationToken` as a query-string
721
632
  // option. By default this end-point will list up to 1000 task queues in a single
722
633
  // page. You may limit this with the query-string parameter `limit`.
723
- /* eslint-enable max-len */
724
634
  listTaskQueues(...args) {
725
635
  this.validate(this.listTaskQueues.entry, args);
726
636
 
727
637
  return this.request(this.listTaskQueues.entry, args);
728
638
  }
729
- /* eslint-disable max-len */
730
639
  // Get a task queue.
731
- /* eslint-enable max-len */
732
640
  getTaskQueue(...args) {
733
641
  this.validate(this.getTaskQueue.entry, args);
734
642
 
735
643
  return this.request(this.getTaskQueue.entry, args);
736
644
  }
737
- /* eslint-disable max-len */
738
645
  // Get a list of all active workers of a workerType.
739
646
  // `listWorkers` allows a response to be filtered by quarantined and non quarantined workers.
740
647
  // To filter the query, you should call the end-point with `quarantined` as a query-string option with a
@@ -743,43 +650,34 @@ export default class Queue extends Client {
743
650
  // should call the end-point again with the `continuationToken` as a query-string
744
651
  // option. By default this end-point will list up to 1000 workers in a single
745
652
  // page. You may limit this with the query-string parameter `limit`.
746
- /* eslint-enable max-len */
747
653
  listWorkers(...args) {
748
654
  this.validate(this.listWorkers.entry, args);
749
655
 
750
656
  return this.request(this.listWorkers.entry, args);
751
657
  }
752
- /* eslint-disable max-len */
753
658
  // Get a worker from a worker-type.
754
- /* eslint-enable max-len */
755
659
  getWorker(...args) {
756
660
  this.validate(this.getWorker.entry, args);
757
661
 
758
662
  return this.request(this.getWorker.entry, args);
759
663
  }
760
- /* eslint-disable max-len */
761
664
  // Quarantine a worker
762
- /* eslint-enable max-len */
763
665
  quarantineWorker(...args) {
764
666
  this.validate(this.quarantineWorker.entry, args);
765
667
 
766
668
  return this.request(this.quarantineWorker.entry, args);
767
669
  }
768
- /* eslint-disable max-len */
769
670
  // Declare a worker, supplying some details about it.
770
671
  // `declareWorker` allows updating one or more properties of a worker as long as the required scopes are
771
672
  // possessed.
772
- /* eslint-enable max-len */
773
673
  declareWorker(...args) {
774
674
  this.validate(this.declareWorker.entry, args);
775
675
 
776
676
  return this.request(this.declareWorker.entry, args);
777
677
  }
778
- /* eslint-disable max-len */
779
678
  // Respond with a service heartbeat.
780
679
  // This endpoint is used to check on backing services this service
781
680
  // depends on.
782
- /* eslint-enable max-len */
783
681
  heartbeat(...args) {
784
682
  this.validate(this.heartbeat.entry, args);
785
683