@taskcluster/client-web 88.0.1

package/src/clients/QueueEvents.js

@@ -0,0 +1,129 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class QueueEvents extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'queue',
+      serviceVersion: 'v1',
+      exchangePrefix: 'exchange/taskcluster-queue/v1/',
+      ...options,
+    });
+  }
+  /* eslint-disable max-len */
+  // When a task is created or just defined a message is posted to this
+  // exchange.
+  // This message exchange is mainly useful when tasks are created with dependencies
+  // on incomplete tasks, as this does not make the task
+  // `pending`. Thus, no `taskPending` message is published.
+  /* eslint-enable max-len */
+  taskDefined(pattern) {
+    const entry = {"exchange":"task-defined","name":"taskDefined","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":false},{"multipleWords":false,"name":"workerGroup","required":false},{"multipleWords":false,"name":"workerId","required":false},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-defined-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // When a task becomes `pending` a message is posted to this exchange.
+  // This is useful for workers who doesn't want to constantly poll the queue
+  // for new tasks. The queue will also be authority for task states and
+  // claims. But using this exchange workers should be able to distribute work
+  // efficiently and they would be able to reduce their polling interval
+  // significantly without affecting general responsiveness.
+  /* eslint-enable max-len */
+  taskPending(pattern) {
+    const entry = {"exchange":"task-pending","name":"taskPending","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":true},{"multipleWords":false,"name":"workerGroup","required":false},{"multipleWords":false,"name":"workerId","required":false},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-pending-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // Whenever a task is claimed by a worker, a run is started on the worker,
+  // and a message is posted on this exchange.
+  /* eslint-enable max-len */
+  taskRunning(pattern) {
+    const entry = {"exchange":"task-running","name":"taskRunning","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":true},{"multipleWords":false,"name":"workerGroup","required":true},{"multipleWords":false,"name":"workerId","required":true},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-running-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // Whenever the `createArtifact` end-point is called, the queue will create
+  // a record of the artifact and post a message on this exchange. All of this
+  // happens before the queue returns a signed URL for the caller to upload
+  // the actual artifact with (pending on `storageType`).
+  // This means that the actual artifact is rarely available when this message
+  // is posted. But it is not unreasonable to assume that the artifact will
+  // will become available at some point later. Most signatures will expire in
+  // 30 minutes or so, forcing the uploader to call `createArtifact` with
+  // the same payload again in-order to continue uploading the artifact.
+  // However, in most cases (especially for small artifacts) it's very
+  // reasonable assume the artifact will be available within a few minutes.
+  // This property means that this exchange is mostly useful for tools
+  // monitoring task evaluation. One could also use it count number of
+  // artifacts per task, or _index_ artifacts though in most cases it'll be
+  // smarter to index artifacts after the task in question have completed
+  // successfully.
+  // *NOTE*: this message is currently only sent for reference and error
+  // artifacts.  This will be remedied in a future version of Taskcluster.
+  /* eslint-enable max-len */
+  artifactCreated(pattern) {
+    const entry = {"exchange":"artifact-created","name":"artifactCreated","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":true},{"multipleWords":false,"name":"workerGroup","required":true},{"multipleWords":false,"name":"workerId","required":true},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/artifact-created-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // When a task is successfully completed by a worker a message is posted
+  // this exchange.
+  // This message is routed using the `runId`, `workerGroup` and `workerId`
+  // that completed the task. But information about additional runs is also
+  // available from the task status structure.
+  /* eslint-enable max-len */
+  taskCompleted(pattern) {
+    const entry = {"exchange":"task-completed","name":"taskCompleted","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":true},{"multipleWords":false,"name":"workerGroup","required":true},{"multipleWords":false,"name":"workerId","required":true},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-completed-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // When a task ran, but failed to complete successfully a message is posted
+  // to this exchange. This is same as worker ran task-specific code, but the
+  // task specific code exited non-zero.
+  /* eslint-enable max-len */
+  taskFailed(pattern) {
+    const entry = {"exchange":"task-failed","name":"taskFailed","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":false},{"multipleWords":false,"name":"workerGroup","required":false},{"multipleWords":false,"name":"workerId","required":false},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-failed-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // Whenever Taskcluster fails to run a message is posted to this exchange.
+  // This happens if the task isn't completed before its `deadlìne`,
+  // all retries failed (i.e. workers stopped responding), the task was
+  // canceled by another entity, or the task carried a malformed payload.
+  // The specific _reason_ is evident from that task status structure, refer
+  // to the `reasonResolved` property for the last run.
+  /* eslint-enable max-len */
+  taskException(pattern) {
+    const entry = {"exchange":"task-exception","name":"taskException","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskId","required":true},{"multipleWords":false,"name":"runId","required":false},{"multipleWords":false,"name":"workerGroup","required":false},{"multipleWords":false,"name":"workerId","required":false},{"multipleWords":false,"name":"provisionerId","required":true},{"multipleWords":false,"name":"workerType","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-exception-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // A message is published on task-group-resolved whenever all submitted
+  // tasks (whether scheduled or unscheduled) for a given task group have
+  // been resolved, regardless of whether they resolved as successful or
+  // not. A task group may be resolved multiple times, since new tasks may
+  // be submitted against an already resolved task group.
+  /* eslint-enable max-len */
+  taskGroupResolved(pattern) {
+    const entry = {"exchange":"task-group-resolved","name":"taskGroupResolved","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-group-changed-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+  /* eslint-disable max-len */
+  // A message is published on task-group-sealed whenever task group is sealed.
+  // This task group will no longer allow creation of new tasks.
+  /* eslint-enable max-len */
+  taskGroupSealed(pattern) {
+    const entry = {"exchange":"task-group-sealed","name":"taskGroupSealed","routingKey":[{"constant":"primary","multipleWords":false,"name":"routingKeyKind","required":true},{"multipleWords":false,"name":"taskGroupId","required":true},{"multipleWords":false,"name":"schedulerId","required":true},{"multipleWords":true,"name":"reserved","required":false}],"schema":"v1/task-group-changed-message.json#","type":"topic-exchange"}; // eslint-disable-line
+
+    return this.normalizePattern(entry, pattern);
+  }
+}

package/src/clients/Secrets.js

@@ -0,0 +1,103 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class Secrets extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'secrets',
+      serviceVersion: 'v1',
+      exchangePrefix: '',
+      ...options,
+    });
+    this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
+    this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.set.entry = {"args":["name"],"category":"Secrets Service","input":true,"method":"put","name":"set","query":[],"route":"/secret/<name>","scopes":"secrets:set:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.remove.entry = {"args":["name"],"category":"Secrets Service","method":"delete","name":"remove","query":[],"route":"/secret/<name>","scopes":"secrets:set:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.get.entry = {"args":["name"],"category":"Secrets Service","method":"get","name":"get","output":true,"query":[],"route":"/secret/<name>","scopes":"secrets:get:<name>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.list.entry = {"args":[],"category":"Secrets Service","method":"get","name":"list","output":true,"query":["continuationToken","limit"],"route":"/secrets","scopes":"secrets:list-secrets","stability":"stable","type":"function"}; // eslint-disable-line
+    this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  ping(...args) {
+    this.validate(this.ping.entry, args);
+
+    return this.request(this.ping.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  lbheartbeat(...args) {
+    this.validate(this.lbheartbeat.entry, args);
+
+    return this.request(this.lbheartbeat.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with the JSON version object.
+  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
+  /* eslint-enable max-len */
+  version(...args) {
+    this.validate(this.version.entry, args);
+
+    return this.request(this.version.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Set the secret associated with some key.  If the secret already exists, it is
+  // updated instead.
+  /* eslint-enable max-len */
+  set(...args) {
+    this.validate(this.set.entry, args);
+
+    return this.request(this.set.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Delete the secret associated with some key. It will succeed whether or not the secret exists
+  /* eslint-enable max-len */
+  remove(...args) {
+    this.validate(this.remove.entry, args);
+
+    return this.request(this.remove.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Read the secret associated with some key.  If the secret has recently
+  // expired, the response code 410 is returned.  If the caller lacks the
+  // scope necessary to get the secret, the call will fail with a 403 code
+  // regardless of whether the secret exists.
+  /* eslint-enable max-len */
+  get(...args) {
+    this.validate(this.get.entry, args);
+
+    return this.request(this.get.entry, args);
+  }
+  /* eslint-disable max-len */
+  // List the names of all secrets.
+  // By default this end-point will try to return up to 1000 secret names 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.
+  /* eslint-enable max-len */
+  list(...args) {
+    this.validate(this.list.entry, args);
+
+    return this.request(this.list.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with a service heartbeat.
+  // This endpoint is used to check on backing services this service
+  // depends on.
+  /* eslint-enable max-len */
+  heartbeat(...args) {
+    this.validate(this.heartbeat.entry, args);
+
+    return this.request(this.heartbeat.entry, args);
+  }
+}

package/src/clients/WorkerManager.js

@@ -0,0 +1,303 @@
+// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+
+import Client from '../Client';
+
+export default class WorkerManager extends Client {
+  constructor(options = {}) {
+    super({
+      serviceName: 'worker-manager',
+      serviceVersion: 'v1',
+      exchangePrefix: '',
+      ...options,
+    });
+    this.ping.entry = {"args":[],"category":"Monitoring","method":"get","name":"ping","query":[],"route":"/ping","stability":"stable","type":"function"}; // eslint-disable-line
+    this.lbheartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"lbheartbeat","query":[],"route":"/__lbheartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.version.entry = {"args":[],"category":"Monitoring","method":"get","name":"version","query":[],"route":"/__version__","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listProviders.entry = {"args":[],"category":"Providers","method":"get","name":"listProviders","output":true,"query":["continuationToken","limit"],"route":"/providers","scopes":"worker-manager:list-providers","stability":"stable","type":"function"}; // eslint-disable-line
+    this.createWorkerPool.entry = {"args":["workerPoolId"],"category":"Worker Pools","input":true,"method":"put","name":"createWorkerPool","output":true,"query":[],"route":"/worker-pool/<workerPoolId>","scopes":{"AllOf":["worker-manager:manage-worker-pool:<workerPoolId>","worker-manager:provider:<providerId>"]},"stability":"stable","type":"function"}; // eslint-disable-line
+    this.updateWorkerPool.entry = {"args":["workerPoolId"],"category":"Worker Pools","input":true,"method":"post","name":"updateWorkerPool","output":true,"query":[],"route":"/worker-pool/<workerPoolId>","scopes":{"AllOf":["worker-manager:manage-worker-pool:<workerPoolId>","worker-manager:provider:<providerId>"]},"stability":"experimental","type":"function"}; // eslint-disable-line
+    this.deleteWorkerPool.entry = {"args":["workerPoolId"],"category":"Worker Pools","method":"delete","name":"deleteWorkerPool","output":true,"query":[],"route":"/worker-pool/<workerPoolId>","scopes":"worker-manager:manage-worker-pool:<workerPoolId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listWorkerPoolLaunchConfigs.entry = {"args":["workerPoolId"],"category":"Worker Pool Launch Configs","method":"get","name":"listWorkerPoolLaunchConfigs","output":true,"query":["continuationToken","limit","includeArchived"],"route":"/worker-pool/<workerPoolId>/launch-configs","scopes":"worker-manager:get-worker-pool:<workerPoolId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.workerPoolStats.entry = {"args":["workerPoolId"],"category":"Worker Pools","method":"get","name":"workerPoolStats","output":true,"query":[],"route":"/worker-pool/<workerPoolId>/stats","scopes":"worker-manager:get-worker-pool:<workerPoolId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.workerPool.entry = {"args":["workerPoolId"],"category":"Worker Pools","method":"get","name":"workerPool","output":true,"query":[],"route":"/worker-pool/<workerPoolId>","scopes":"worker-manager:get-worker-pool:<workerPoolId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listWorkerPools.entry = {"args":[],"category":"Worker Pools","method":"get","name":"listWorkerPools","output":true,"query":["continuationToken","limit"],"route":"/worker-pools","scopes":"worker-manager:list-worker-pools","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listWorkerPoolsStats.entry = {"args":[],"category":"Worker Pools","method":"get","name":"listWorkerPoolsStats","output":true,"query":["continuationToken","limit"],"route":"/worker-pools/stats","scopes":"worker-manager:list-worker-pools","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.reportWorkerError.entry = {"args":["workerPoolId"],"category":"Worker Interface","input":true,"method":"post","name":"reportWorkerError","output":true,"query":[],"route":"/worker-pool-errors/<workerPoolId>","scopes":{"AllOf":["assume:worker-pool:<workerPoolId>","assume:worker-id:<workerGroup>/<workerId>"]},"stability":"stable","type":"function"}; // eslint-disable-line
+    this.workerPoolErrorStats.entry = {"args":[],"category":"Worker Pools","method":"get","name":"workerPoolErrorStats","output":true,"query":["workerPoolId"],"route":"/worker-pool-errors/stats","scopes":"worker-manager:list-worker-pool-errors:<workerPoolId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.listWorkerPoolErrors.entry = {"args":["workerPoolId"],"category":"Worker Pools","method":"get","name":"listWorkerPoolErrors","output":true,"query":["continuationToken","limit","launchConfigId","errorId"],"route":"/worker-pool-errors/<workerPoolId>","scopes":"worker-manager:list-worker-pool-errors:<workerPoolId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listWorkersForWorkerGroup.entry = {"args":["workerPoolId","workerGroup"],"category":"Workers","method":"get","name":"listWorkersForWorkerGroup","output":true,"query":["continuationToken","limit"],"route":"/workers/<workerPoolId>/<workerGroup>","scopes":"worker-manager:list-workers:<workerPoolId>/<workerGroup>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.worker.entry = {"args":["workerPoolId","workerGroup","workerId"],"category":"Workers","method":"get","name":"worker","output":true,"query":[],"route":"/workers/<workerPoolId>/<workerGroup>/<workerId>","scopes":"worker-manager:get-worker:<workerPoolId>/<workerGroup>/<workerId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.createWorker.entry = {"args":["workerPoolId","workerGroup","workerId"],"category":"Workers","input":true,"method":"put","name":"createWorker","output":true,"query":[],"route":"/workers/<workerPoolId>/<workerGroup>/<workerId>","scopes":"worker-manager:create-worker:<workerPoolId>/<workerGroup>/<workerId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.updateWorker.entry = {"args":["workerPoolId","workerGroup","workerId"],"category":"Workers","input":true,"method":"post","name":"updateWorker","output":true,"query":[],"route":"/workers/<workerPoolId>/<workerGroup>/<workerId>","scopes":"worker-manager:update-worker:<workerPoolId>/<workerGroup>/<workerId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.removeWorker.entry = {"args":["workerPoolId","workerGroup","workerId"],"category":"Workers","method":"delete","name":"removeWorker","query":[],"route":"/workers/<workerPoolId>/<workerGroup>/<workerId>","scopes":"worker-manager:remove-worker:<workerPoolId>/<workerGroup>/<workerId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.listWorkersForWorkerPool.entry = {"args":["workerPoolId"],"category":"Workers","method":"get","name":"listWorkersForWorkerPool","output":true,"query":["continuationToken","limit","launchConfigId","state"],"route":"/workers/<workerPoolId>","scopes":"worker-manager:list-workers:<workerPoolId>","stability":"stable","type":"function"}; // eslint-disable-line
+    this.registerWorker.entry = {"args":[],"category":"Worker Interface","input":true,"method":"post","name":"registerWorker","output":true,"query":[],"route":"/worker/register","stability":"stable","type":"function"}; // eslint-disable-line
+    this.reregisterWorker.entry = {"args":[],"category":"Worker Interface","input":true,"method":"post","name":"reregisterWorker","output":true,"query":[],"route":"/worker/reregister","scopes":"worker-manager:reregister-worker:<workerPoolId>/<workerGroup>/<workerId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.listWorkers.entry = {"args":["provisionerId","workerType"],"category":"Worker Metadata","method":"get","name":"listWorkers","output":true,"query":["continuationToken","limit","launchConfigId","quarantined","workerState"],"route":"/provisioners/<provisionerId>/worker-types/<workerType>/workers","scopes":"worker-manager:list-workers:<provisionerId>/<workerType>","stability":"experimental","type":"function"}; // eslint-disable-line
+    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":"worker-manager:get-worker:<provisionerId>/<workerType>/<workerGroup>/<workerId>","stability":"experimental","type":"function"}; // eslint-disable-line
+    this.heartbeat.entry = {"args":[],"category":"Monitoring","method":"get","name":"heartbeat","query":[],"route":"/__heartbeat__","stability":"stable","type":"function"}; // eslint-disable-line
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  ping(...args) {
+    this.validate(this.ping.entry, args);
+
+    return this.request(this.ping.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond without doing anything.
+  // This endpoint is used to check that the service is up.
+  /* eslint-enable max-len */
+  lbheartbeat(...args) {
+    this.validate(this.lbheartbeat.entry, args);
+
+    return this.request(this.lbheartbeat.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with the JSON version object.
+  // https://github.com/mozilla-services/Dockerflow/blob/main/docs/version_object.md
+  /* eslint-enable max-len */
+  version(...args) {
+    this.validate(this.version.entry, args);
+
+    return this.request(this.version.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Retrieve a list of providers that are available for worker pools.
+  /* eslint-enable max-len */
+  listProviders(...args) {
+    this.validate(this.listProviders.entry, args);
+
+    return this.request(this.listProviders.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Create a new worker pool. If the worker pool already exists, this will throw an error.
+  /* eslint-enable max-len */
+  createWorkerPool(...args) {
+    this.validate(this.createWorkerPool.entry, args);
+
+    return this.request(this.createWorkerPool.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Given an existing worker pool definition, this will modify it and return
+  // the new definition.
+  // To delete a worker pool, set its `providerId` to `"null-provider"`.
+  // After any existing workers have exited, a cleanup job will remove the
+  // worker pool.  During that time, the worker pool can be updated again, such
+  // as to set its `providerId` to a real provider.
+  /* eslint-enable max-len */
+  updateWorkerPool(...args) {
+    this.validate(this.updateWorkerPool.entry, args);
+
+    return this.request(this.updateWorkerPool.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Mark a worker pool for deletion.  This is the same as updating the pool to
+  // set its providerId to `"null-provider"`, but does not require scope
+  // `worker-manager:provider:null-provider`.
+  // This will also mark all launch configurations as archived.
+  /* eslint-enable max-len */
+  deleteWorkerPool(...args) {
+    this.validate(this.deleteWorkerPool.entry, args);
+
+    return this.request(this.deleteWorkerPool.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of launch configurations for a given worker pool.
+  // Include archived launch configurations by setting includeArchived=true.
+  // By default, only active launch configurations are returned.
+  /* eslint-enable max-len */
+  listWorkerPoolLaunchConfigs(...args) {
+    this.validate(this.listWorkerPoolLaunchConfigs.entry, args);
+
+    return this.request(this.listWorkerPoolLaunchConfigs.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Fetch statistics for an existing worker pool, broken down by launch configuration.
+  // This includes counts and capacities of requested, running, stopping, and stopped workers.
+  /* eslint-enable max-len */
+  workerPoolStats(...args) {
+    this.validate(this.workerPoolStats.entry, args);
+
+    return this.request(this.workerPoolStats.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Fetch an existing worker pool defition.
+  /* eslint-enable max-len */
+  workerPool(...args) {
+    this.validate(this.workerPool.entry, args);
+
+    return this.request(this.workerPool.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of all the existing worker pools.
+  /* eslint-enable max-len */
+  listWorkerPools(...args) {
+    this.validate(this.listWorkerPools.entry, args);
+
+    return this.request(this.listWorkerPools.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the stats for all worker pools - number of requested, running, stopping and stopped capacity
+  /* eslint-enable max-len */
+  listWorkerPoolsStats(...args) {
+    this.validate(this.listWorkerPoolsStats.entry, args);
+
+    return this.request(this.listWorkerPoolsStats.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Report an error that occurred on a worker.  This error will be included
+  // with the other errors in `listWorkerPoolErrors(workerPoolId)`.
+  // Workers can use this endpoint to report startup or configuration errors
+  // that might be associated with the worker pool configuration and thus of
+  // interest to a worker-pool administrator.
+  // NOTE: errors are publicly visible.  Ensure that none of the content
+  // contains secrets or other sensitive information.
+  /* eslint-enable max-len */
+  reportWorkerError(...args) {
+    this.validate(this.reportWorkerError.entry, args);
+
+    return this.request(this.reportWorkerError.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of worker pool errors count.
+  // Contains total count of errors for the past 7 days and 24 hours
+  // Also includes total counts grouped by titles of error and error code.
+  // If `workerPoolId` is not specified, it will return the count of all errors
+  /* eslint-enable max-len */
+  workerPoolErrorStats(...args) {
+    this.validate(this.workerPoolErrorStats.entry, args);
+
+    return this.request(this.workerPoolErrorStats.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of worker pool errors.
+  /* eslint-enable max-len */
+  listWorkerPoolErrors(...args) {
+    this.validate(this.listWorkerPoolErrors.entry, args);
+
+    return this.request(this.listWorkerPoolErrors.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of all the existing workers in a given group in a given worker pool.
+  /* eslint-enable max-len */
+  listWorkersForWorkerGroup(...args) {
+    this.validate(this.listWorkersForWorkerGroup.entry, args);
+
+    return this.request(this.listWorkersForWorkerGroup.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get a single worker.
+  /* eslint-enable max-len */
+  worker(...args) {
+    this.validate(this.worker.entry, args);
+
+    return this.request(this.worker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Create a new worker.  This is only useful for worker pools where the provider
+  // does not create workers automatically, such as those with a `static` provider
+  // type.  Providers that do not support creating workers will return a 400 error.
+  // See the documentation for the individual providers, and in particular the
+  // [static provider](https://docs.taskcluster.net/docs/reference/core/worker-manager/)
+  // for more information.
+  /* eslint-enable max-len */
+  createWorker(...args) {
+    this.validate(this.createWorker.entry, args);
+
+    return this.request(this.createWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Update an existing worker in-place.  Like `createWorker`, this is only useful for
+  // worker pools where the provider does not create workers automatically.
+  // This method allows updating all fields in the schema unless otherwise indicated
+  // in the provider documentation.
+  // See the documentation for the individual providers, and in particular the
+  // [static provider](https://docs.taskcluster.net/docs/reference/core/worker-manager/)
+  // for more information.
+  /* eslint-enable max-len */
+  updateWorker(...args) {
+    this.validate(this.updateWorker.entry, args);
+
+    return this.request(this.updateWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Remove an existing worker.  The precise behavior of this method depends
+  // on the provider implementing the given worker.  Some providers
+  // do not support removing workers at all, and will return a 400 error.
+  // Others may begin removing the worker, but it may remain available via
+  // the API (perhaps even in state RUNNING) afterward.
+  /* eslint-enable max-len */
+  removeWorker(...args) {
+    this.validate(this.removeWorker.entry, args);
+
+    return this.request(this.removeWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get the list of all the existing workers in a given worker pool.
+  /* eslint-enable max-len */
+  listWorkersForWorkerPool(...args) {
+    this.validate(this.listWorkersForWorkerPool.entry, args);
+
+    return this.request(this.listWorkersForWorkerPool.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Register a running worker.  Workers call this method on worker start-up.
+  // This call both marks the worker as running and returns the credentials
+  // the worker will require to perform its work.  The worker must provide
+  // some proof of its identity, and that proof varies by provider type.
+  /* eslint-enable max-len */
+  registerWorker(...args) {
+    this.validate(this.registerWorker.entry, args);
+
+    return this.request(this.registerWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Reregister a running worker.
+  // This will generate and return new Taskcluster credentials for the worker
+  // on that instance to use. The credentials will not live longer the
+  // `registrationTimeout` for that worker. The endpoint will update `terminateAfter`
+  // for the worker so that worker-manager does not terminate the instance.
+  /* eslint-enable max-len */
+  reregisterWorker(...args) {
+    this.validate(this.reregisterWorker.entry, args);
+
+    return this.request(this.reregisterWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get a list of all active workers of a workerType.
+  // `listWorkers` allows a response to be filtered by quarantined and non quarantined workers,
+  // as well as the current state of the worker.
+  // To filter the query, you should call the end-point with one of [`quarantined`, `workerState`]
+  // as a query-string option with a true or false value.
+  // The response is paged. If this end-point returns a `continuationToken`, you
+  // should call the end-point again with the `continuationToken` as a query-string
+  // option. By default this end-point will list up to 1000 workers in a single
+  // page. You may limit this with the query-string parameter `limit`.
+  /* eslint-enable max-len */
+  listWorkers(...args) {
+    this.validate(this.listWorkers.entry, args);
+
+    return this.request(this.listWorkers.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Get a worker from a worker-type.
+  /* eslint-enable max-len */
+  getWorker(...args) {
+    this.validate(this.getWorker.entry, args);
+
+    return this.request(this.getWorker.entry, args);
+  }
+  /* eslint-disable max-len */
+  // Respond with a service heartbeat.
+  // This endpoint is used to check on backing services this service
+  // depends on.
+  /* eslint-enable max-len */
+  heartbeat(...args) {
+    this.validate(this.heartbeat.entry, args);
+
+    return this.request(this.heartbeat.entry, args);
+  }
+}