public class Queue extends TaskclusterRequestHandler
The queue, typically available at queue.taskcluster.net, is responsible for accepting tasks and track their state as they are executed by workers. In order ensure they are eventually resolved.
This document describes the API end-points offered by the queue. These end-points targets the following audience: * Schedulers, who create tasks to be executed, * Workers, who execute tasks, and * Tools, that wants to inspect the state of a task.
| Modifier and Type | Field and Description |
|---|---|
protected static String |
defaultBaseURL |
| Constructor and Description |
|---|
Queue() |
Queue(Credentials credentials) |
Queue(Credentials credentials,
String baseURL) |
Queue(String baseURL) |
Queue(String clientId,
String accessToken) |
Queue(String clientId,
String accessToken,
String certificate) |
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,TaskStatusResponse> |
cancelTask(String taskId)
This method will cancel a task that is either
unscheduled, pending or running. |
CallSummary<TaskClaimRequest,TaskClaimResponse> |
claimTask(String taskId,
String runId,
TaskClaimRequest payload)
claim a task - never documentedRequired scopes: Any of: - All of: * queue:claim-task:
|
CallSummary<ClaimWorkRequest,ClaimWorkResponse> |
claimWork(String provisionerId,
String workerType,
ClaimWorkRequest payload)
Claim pending task(s) for the given
provisionerId/workerType queue. |
CallSummary<CompleteArtifactRequest,EmptyPayload> |
completeArtifact(String taskId,
String runId,
String name,
CompleteArtifactRequest payload)
This endpoint finalises an upload done through the blob
storageType. |
CallSummary<Object,Object> |
createArtifact(String taskId,
String runId,
String name,
Object payload)
This API end-point creates an artifact for a specific run of a task.
|
CallSummary<TaskDefinitionRequest,TaskStatusResponse> |
createTask(String taskId,
TaskDefinitionRequest payload)
Create a new task, this is an idempotent operation, so repeat it if you get an internal server error or network connection is dropped.
|
CallSummary<ProvisionerRequest,ProvisionerResponse> |
declareProvisioner(String provisionerId,
ProvisionerRequest payload)
Declare a provisioner, supplying some details about it.
|
CallSummary<WorkerRequest,WorkerResponse> |
declareWorker(String provisionerId,
String workerType,
String workerGroup,
String workerId,
WorkerRequest payload)
Declare a worker, supplying some details about it.
|
CallSummary<WorkerTypeRequest,WorkerTypeResponse> |
declareWorkerType(String provisionerId,
String workerType,
WorkerTypeRequest payload)
Declare a workerType, supplying some details about it.
|
CallSummary<TaskDefinitionRequest,TaskStatusResponse> |
defineTask(String taskId,
TaskDefinitionRequest payload)
Deprecated, this is the same as
createTask with a self-dependency. |
CallSummary<EmptyPayload,EmptyPayload> |
getArtifact(String taskId,
String runId,
String name)
Get artifact by
<name> from a specific run. |
CallSummary<EmptyPayload,EmptyPayload> |
getLatestArtifact(String taskId,
String name)
Get artifact by
<name> from the last run of a task. |
CallSummary<EmptyPayload,ProvisionerResponse> |
getProvisioner(String provisionerId)
Get an active provisioner.
|
CallSummary<EmptyPayload,WorkerResponse> |
getWorker(String provisionerId,
String workerType,
String workerGroup,
String workerId)
Get a worker from a worker-type.
|
CallSummary<EmptyPayload,WorkerTypeResponse> |
getWorkerType(String provisionerId,
String workerType)
Get a worker-type from a provisioner.
|
CallSummary<EmptyPayload,ListArtifactsResponse> |
listArtifacts(String taskId,
String runId)
Returns a list of artifacts and associated meta-data for a given run.
|
CallSummary<EmptyPayload,ListDependentTasksResponse> |
listDependentTasks(String taskId)
List tasks that depend on the given
taskId. |
CallSummary<EmptyPayload,ListArtifactsResponse> |
listLatestArtifacts(String taskId)
Returns a list of artifacts and associated meta-data for the latest run from the given task.
|
CallSummary<EmptyPayload,ListProvisionersResponse> |
listProvisioners()
Get all active provisioners.
|
CallSummary<EmptyPayload,ListTaskGroupResponse> |
listTaskGroup(String taskGroupId)
List tasks sharing the same
taskGroupId. |
CallSummary<EmptyPayload,ListWorkersResponse> |
listWorkers(String provisionerId,
String workerType)
Get a list of all active workers of a workerType.
|
CallSummary<EmptyPayload,ListWorkerTypesResponse> |
listWorkerTypes(String provisionerId)
Get all active worker-types for the given provisioner.
|
CallSummary<EmptyPayload,CountPendingTasksResponse> |
pendingTasks(String provisionerId,
String workerType)
Get an approximate number of pending tasks for the given
provisionerId and workerType. |
CallSummary<EmptyPayload,EmptyPayload> |
ping()
Respond without doing anything.
|
CallSummary<QuarantineWorkerRequest,WorkerResponse> |
quarantineWorker(String provisionerId,
String workerType,
String workerGroup,
String workerId,
QuarantineWorkerRequest payload)
Quarantine a workerRequired scopes: queue:quarantine-worker:
|
CallSummary<EmptyPayload,TaskReclaimResponse> |
reclaimTask(String taskId,
String runId)
Refresh the claim for a specific
runId for given taskId. |
CallSummary<EmptyPayload,TaskStatusResponse> |
reportCompleted(String taskId,
String runId)
Report a task completed, resolving the run as
completed. |
CallSummary<TaskExceptionRequest,TaskStatusResponse> |
reportException(String taskId,
String runId,
TaskExceptionRequest payload)
Resolve a run as exception.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
reportFailed(String taskId,
String runId)
Report a run failed, resolving the run as
failed. |
CallSummary<EmptyPayload,TaskStatusResponse> |
rerunTask(String taskId)
This method reruns a previously resolved task, even if it was completed.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
scheduleTask(String taskId)
scheduleTask will schedule a task to be executed, even if it has unresolved dependencies.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
status(String taskId)
Get task status structure from
taskId |
CallSummary<EmptyPayload,TaskDefinitionResponse> |
task(String taskId)
This end-point will return the task-definition.
|
apiCall, setBaseURL, uriEncodeprotected static final String defaultBaseURL
public Queue(Credentials credentials)
public Queue(Credentials credentials, String baseURL)
public Queue(String baseURL)
public Queue()
public CallSummary<EmptyPayload,EmptyPayload> ping() throws APICallFailure
Respond without doing anything. This endpoint is used to check that the service is up.
APICallFailurepublic CallSummary<EmptyPayload,TaskDefinitionResponse> task(String taskId) throws APICallFailure
This end-point will return the task-definition. Notice that the task definition may have been modified by queue, if an optional property is not specified the queue may provide a default value.
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> status(String taskId) throws APICallFailure
Get task status structure from taskId
APICallFailurepublic CallSummary<EmptyPayload,ListTaskGroupResponse> listTaskGroup(String taskGroupId) throws APICallFailure
List tasks sharing the same taskGroupId.
As a task-group may contain an unbounded number of tasks, this end-point may return a continuationToken. To continue listing tasks you must call the listTaskGroup again with the continuationToken as the query-string option continuationToken.
By default this end-point will try to return up to 1000 members in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listTaskGroup with the last continuationToken until you get a result without a continuationToken.
If you are not interested in listing all the members at once, you may use the query-string option limit to return fewer.
APICallFailurepublic CallSummary<EmptyPayload,ListDependentTasksResponse> listDependentTasks(String taskId) throws APICallFailure
List tasks that depend on the given taskId.
As many tasks from different task-groups may dependent on a single tasks, this end-point may return a continuationToken. To continue listing tasks you must call listDependentTasks again with the continuationToken as the query-string option continuationToken.
By default this end-point will try to return up to 1000 tasks in one request. But it may return less, even if more tasks are available. It may also return a continuationToken even though there are no more results. However, you can only be sure to have seen all results if you keep calling listDependentTasks with the last continuationToken until you get a result without a continuationToken.
If you are not interested in listing all the tasks at once, you may use the query-string option limit to return fewer.
APICallFailurepublic CallSummary<TaskDefinitionRequest,TaskStatusResponse> createTask(String taskId, TaskDefinitionRequest payload) throws APICallFailure
Create a new task, this is an idempotent operation, so repeat it if you get an internal server error or network connection is dropped.
Task deadline: the deadline property can be no more than 5 days into the future. This is to limit the amount of pending tasks not being taken care of. Ideally, you should use a much shorter deadline.
Task expiration: the expires property must be greater than the task deadline. If not provided it will default to deadline + one year. Notice, that artifacts created by task must expire before the task.
Task specific routing-keys: using the task.routes property you may define task specific routing-keys. If a task has a task specific routing-key: <route>, then when the AMQP message about the task is published, the message will be CC’ed with the routing-key: route.<route>. This is useful if you want another component to listen for completed tasks you have posted. The caller must have scope queue:route:<route> for each route.
Dependencies: any tasks referenced in task.dependencies must have already been created at the time of this call.
Scopes: Note that the scopes required to complete this API call depend on the content of the scopes, routes, schedulerId, priority, provisionerId, and workerType properties of the task definition.
Legacy Scopes: The queue:create-task:.. scope without a priority and the queue:define-task:.. and queue:task-group-id:.. scopes are considered legacy and should not be used. Note that the new, non-legacy scopes require a queue:scheduler-id:.. scope as well as scopes for the proper priority.
Required scopes: All of: * For scope in scopes each
APICallFailurepublic CallSummary<TaskDefinitionRequest,TaskStatusResponse> defineTask(String taskId, TaskDefinitionRequest payload) throws APICallFailure
Deprecated, this is the same as createTask with a self-dependency. This is only present for legacy.
Required scopes: All of: * For scope in scopes each
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> scheduleTask(String taskId) throws APICallFailure
scheduleTask will schedule a task to be executed, even if it has unresolved dependencies. A task would otherwise only be scheduled if its dependencies were resolved.
This is useful if you have defined a task that depends on itself or on some other task that has not been resolved, but you wish the task to be scheduled immediately.
This will announce the task as pending and workers will be allowed to claim it and resolve the task.
Note this operation is idempotent and will not fail or complain if called with a taskId that is already scheduled, or even resolved. To reschedule a task previously resolved, use rerunTask.
Required scopes: Any of: - queue:schedule-task:
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> rerunTask(String taskId) throws APICallFailure
This method reruns a previously resolved task, even if it was completed. This is useful if your task completes unsuccessfully, and you just want to run it from scratch again. This will also reset the number of retries allowed.
Remember that retries in the task status counts the number of runs that the queue have started because the worker stopped responding, for example because a spot node died.
Remark this operation is idempotent, if you try to rerun a task that is not either failed or completed, this operation will just return the current task status.
Required scopes: Any of: - queue:rerun-task:
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> cancelTask(String taskId) throws APICallFailure
This method will cancel a task that is either unscheduled, pending or running. It will resolve the current run as exception with reasonResolved set to canceled. If the task isn’t scheduled yet, ie. it doesn’t have any runs, an initial run will be added and resolved as described above. Hence, after canceling a task, it cannot be scheduled with queue.scheduleTask, but a new run can be created with queue.rerun. These semantics is equivalent to calling queue.scheduleTask immediately followed by queue.cancelTask.
Remark this operation is idempotent, if you try to cancel a task that isn’t unscheduled, pending or running, this operation will just return the current task status.
Required scopes: Any of: - queue:cancel-task:
APICallFailurepublic CallSummary<ClaimWorkRequest,ClaimWorkResponse> claimWork(String provisionerId, String workerType, ClaimWorkRequest payload) throws APICallFailure
Claim pending task(s) for the given provisionerId/workerType queue.
If any work is available (even if fewer than the requested number of tasks, this will return immediately. Otherwise, it will block for tens of seconds waiting for work. If no work appears, it will return an emtpy list of tasks. Callers should sleep a short while (to avoid denial of service in an error condition) and call the endpoint again. This is a simple implementation of “long polling”.
Required scopes: All of: * queue:claim-work:
APICallFailurepublic CallSummary<TaskClaimRequest,TaskClaimResponse> claimTask(String taskId, String runId, TaskClaimRequest payload) throws APICallFailure
claim a task - never documented
Required scopes: Any of: - All of: * queue:claim-task:
APICallFailurepublic CallSummary<EmptyPayload,TaskReclaimResponse> reclaimTask(String taskId, String runId) throws APICallFailure
Refresh the claim for a specific runId for given taskId. This updates the takenUntil property and returns a new set of temporary credentials for performing requests on behalf of the task. These credentials should be used in-place of the credentials returned by claimWork.
The reclaimTask requests serves to: * Postpone takenUntil preventing the queue from resolving claim-expired, * Refresh temporary credentials used for processing the task, and * Abort execution if the task/run have been resolved.
If the takenUntil timestamp is exceeded the queue will resolve the run as exception with reason claim-expired, and proceeded to retry to the task. This ensures that tasks are retried, even if workers disappear without warning.
If the task is resolved, this end-point will return 409 reporting RequestConflict. This typically happens if the task have been canceled or the task.deadline have been exceeded. If reclaiming fails, workers should abort the task and forget about the given runId. There is no need to resolve the run or upload artifacts.
Required scopes: Any of: - queue:reclaim-task:
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> reportCompleted(String taskId, String runId) throws APICallFailure
Report a task completed, resolving the run as completed.
Required scopes: Any of: - queue:resolve-task:
APICallFailurepublic CallSummary<EmptyPayload,TaskStatusResponse> reportFailed(String taskId, String runId) throws APICallFailure
Report a run failed, resolving the run as failed. Use this to resolve a run that failed because the task specific code behaved unexpectedly. For example the task exited non-zero, or didn’t produce expected output.
Do not use this if the task couldn’t be run because if malformed payload, or other unexpected condition. In these cases we have a task exception, which should be reported with reportException.
Required scopes: Any of: - queue:resolve-task:
APICallFailurepublic CallSummary<TaskExceptionRequest,TaskStatusResponse> reportException(String taskId, String runId, TaskExceptionRequest payload) throws APICallFailure
Resolve a run as exception. Generally, you will want to report tasks as failed instead of exception. You should reportException if,
task.payload is invalid,Do not use this to signal that some user-specified code crashed for any reason specific to this code. If user-specific code hits a resource that is temporarily unavailable worker should report task failed.
Required scopes: Any of: - queue:resolve-task:
APICallFailurepublic CallSummary<Object,Object> createArtifact(String taskId, String runId, String name, Object payload) throws APICallFailure
This API end-point creates an artifact for a specific run of a task. This should only be used by a worker currently operating on this task, or from a process running within the task (ie. on the worker).
All artifacts must specify when they expires, the queue will automatically take care of deleting artifacts past their expiration point. This features makes it feasible to upload large intermediate artifacts from data processing applications, as the artifacts can be set to expire a few days later.
We currently support 3 different storageTypes, each storage type have slightly different features and in some cases difference semantics. We also have 2 deprecated storageTypes which are only maintained for backwards compatiability and should not be used in new implementations
Blob artifacts, are useful for storing large files. Currently, these are all stored in S3 but there are facilities for adding support for other backends in futre. A call for this type of artifact must provide information about the file which will be uploaded. This includes sha256 sums and sizes. This method will return a list of general form HTTP requests which are signed by AWS S3 credentials managed by the Queue. Once these requests are completed the list of ETag values returned by the requests must be passed to the queue completeArtifact method
S3 artifacts, DEPRECATED is useful for static files which will be stored on S3. When creating an S3 artifact the queue will return a pre-signed URL to which you can do a PUT request to upload your artifact. Note that PUT request must specify the content-length header and must give the content-type header the same value as in the request to createArtifact.
Azure artifacts, DEPRECATED are stored in Azure Blob Storage service which given the consistency guarantees and API interface offered by Azure is more suitable for artifacts that will be modified during the execution of the task. For example docker-worker has a feature that persists the task log to Azure Blob Storage every few seconds creating a somewhat live log. A request to create an Azure artifact will return a URL featuring a Shared-Access-Signature, refer to MSDN for further information on how to use these. Warning: azure artifact is currently an experimental feature subject to changes and data-drops.
Reference artifacts, only consists of meta-data which the queue will store for you. These artifacts really only have a url property and when the artifact is requested the client will be redirect the URL provided with a 303 (See Other) redirect. Please note that we cannot delete artifacts you upload to other service, we can only delete the reference to the artifact, when it expires.
Error artifacts, only consists of meta-data which the queue will store for you. These artifacts are only meant to indicate that you the worker or the task failed to generate a specific artifact, that you would otherwise have uploaded. For example docker-worker will upload an error artifact, if the file it was supposed to upload doesn’t exists or turns out to be a directory. Clients requesting an error artifact will get a 424 (Failed Dependency) response. This is mainly designed to ensure that dependent tasks can distinguish between artifacts that were suppose to be generated and artifacts for which the name is misspelled.
Artifact immutability, generally speaking you cannot overwrite an artifact when created. But if you repeat the request with the same properties the request will succeed as the operation is idempotent. This is useful if you need to refresh a signed URL while uploading. Do not abuse this to overwrite artifacts created by another entity! Such as worker-host overwriting artifact created by worker-code.
As a special case the url property on reference artifacts can be updated. You should only use this to update the url property for reference artifacts your process has created.
Required scopes: Any of: - queue:create-artifact:
APICallFailurepublic CallSummary<CompleteArtifactRequest,EmptyPayload> completeArtifact(String taskId, String runId, String name, CompleteArtifactRequest payload) throws APICallFailure
This endpoint finalises an upload done through the blob storageType. The queue will ensure that the task/run is still allowing artifacts to be uploaded. For single-part S3 blob artifacts, this endpoint will simply ensure the artifact is present in S3. For multipart S3 artifacts, the endpoint will perform the commit step of the multipart upload flow. As the final step for both multi and single part artifacts, the present entity field will be set to true to reflect that the artifact is now present and a message published to pulse. NOTE: This endpoint must be called for all artifacts of storageType ‘blob’
Required scopes: Any of: - queue:create-artifact:
APICallFailurepublic CallSummary<EmptyPayload,EmptyPayload> getArtifact(String taskId, String runId, String name) throws APICallFailure
Get artifact by <name> from a specific run.
Public Artifacts, in-order to get an artifact you need the scope queue:get-artifact:<name>, where <name> is the name of the artifact. But if the artifact name starts with public/, authentication and authorization is not necessary to fetch the artifact.
API Clients, this method will redirect you to the artifact, if it is stored externally. Either way, the response may not be JSON. So API client users might want to generate a signed URL for this end-point and use that URL with an HTTP client that can handle responses correctly.
Downloading artifacts There are some special considerations for those http clients which download artifacts. This api endpoint is designed to be compatible with an HTTP 1.1 compliant client, but has extra features to ensure the download is valid. It is strongly recommend that consumers use either taskcluster-lib-artifact (JS), taskcluster-lib-artifact-go (Go) or the CLI written in Go to interact with artifacts.
In order to download an artifact the following must be done:
Location header. There are multiple artifact storage types which use a 300-series redirect.reference must not occurblob and does not have x-taskcluster-location-content-sha256 or x-taskcluster-location-content-length must be treated as an errorHeaders The following important headers are set on the response to this method:
The following important headers are set on responses to this method for Blob artifacts
gzip or identity right now. This is hardcoded to a value set when the artifact was created and no content-negotiation occursCaching, artifacts may be cached in data centers closer to the workers in-order to reduce bandwidth costs. This can lead to longer response times. Caching can be skipped by setting the header x-taskcluster-skip-cache: true, this should only be used for resources where request volume is known to be low, and caching not useful. (This feature may be disabled in the future, use is sparingly!)
Required scopes: If private: queue:get-artifact:
APICallFailurepublic CallSummary<EmptyPayload,EmptyPayload> getLatestArtifact(String taskId, String name) throws APICallFailure
Get artifact by <name> from the last run of a task.
Public Artifacts, in-order to get an artifact you need the scope queue:get-artifact:<name>, where <name> is the name of the artifact. But if the artifact name starts with public/, authentication and authorization is not necessary to fetch the artifact.
API Clients, this method will redirect you to the artifact, if it is stored externally. Either way, the response may not be JSON. So API client users might want to generate a signed URL for this end-point and use that URL with a normal HTTP client.
Remark, this end-point is slightly slower than queue.getArtifact, so consider that if you already know the runId of the latest run. Otherwise, just us the most convenient API end-point.
Required scopes: If private: queue:get-artifact:
APICallFailurepublic CallSummary<EmptyPayload,ListArtifactsResponse> listArtifacts(String taskId, String runId) throws APICallFailure
Returns a list of artifacts and associated meta-data for a given run.
As a task may have many artifacts paging may be necessary. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as the query-string option: continuationToken.
By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter limit.
APICallFailurepublic CallSummary<EmptyPayload,ListArtifactsResponse> listLatestArtifacts(String taskId) throws APICallFailure
Returns a list of artifacts and associated meta-data for the latest run from the given task.
As a task may have many artifacts paging may be necessary. If this end-point returns a continuationToken, you should call the end-point again with the continuationToken as the query-string option: continuationToken.
By default this end-point will list up-to 1000 artifacts in a single page you may limit this with the query-string parameter limit.
APICallFailurepublic CallSummary<EmptyPayload,ListProvisionersResponse> listProvisioners() throws APICallFailure
Get all active provisioners.
The term “provisioner” is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.
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 provisioners in a single page. You may limit this with the query-string parameter limit.
APICallFailurepublic CallSummary<EmptyPayload,ProvisionerResponse> getProvisioner(String provisionerId) throws APICallFailure
Get an active provisioner.
The term “provisioner” is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.
APICallFailurepublic CallSummary<ProvisionerRequest,ProvisionerResponse> declareProvisioner(String provisionerId, ProvisionerRequest payload) throws APICallFailure
Declare a provisioner, supplying some details about it.
declareProvisioner allows updating one or more properties of a provisioner as long as the required scopes are possessed. For example, a request to update the aws-provisioner-v1 provisioner with a body {description: 'This provisioner is great'} would require you to have the scope queue:declare-provisioner:aws-provisioner-v1#description.
The term “provisioner” is taken broadly to mean anything with a provisionerId. This does not necessarily mean there is an associated service performing any provisioning activity.
Required scopes: For property in properties each queue:declare-provisioner:
APICallFailurepublic CallSummary<EmptyPayload,CountPendingTasksResponse> pendingTasks(String provisionerId, String workerType) throws APICallFailure
Get an approximate number of pending tasks for the given provisionerId and workerType.
The underlying Azure Storage Queues only promises to give us an estimate. Furthermore, we cache the result in memory for 20 seconds. So consumers should be no means expect this to be an accurate number. It is, however, a solid estimate of the number of pending tasks.
APICallFailurepublic CallSummary<EmptyPayload,ListWorkerTypesResponse> listWorkerTypes(String provisionerId) throws APICallFailure
Get all active worker-types for the given provisioner.
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 worker-types in a single page. You may limit this with the query-string parameter limit.
APICallFailurepublic CallSummary<EmptyPayload,WorkerTypeResponse> getWorkerType(String provisionerId, String workerType) throws APICallFailure
Get a worker-type from a provisioner.
APICallFailurepublic CallSummary<WorkerTypeRequest,WorkerTypeResponse> declareWorkerType(String provisionerId, String workerType, WorkerTypeRequest payload) throws APICallFailure
Declare a workerType, supplying some details about it.
declareWorkerType allows updating one or more properties of a worker-type as long as the required scopes are possessed. For example, a request to update the gecko-b-1-w2008 worker-type within the aws-provisioner-v1 provisioner with a body {description: 'This worker type is great'} would require you to have the scope queue:declare-worker-type:aws-provisioner-v1/gecko-b-1-w2008#description.
Required scopes: For property in properties each queue:declare-worker-type:
APICallFailurepublic CallSummary<EmptyPayload,ListWorkersResponse> listWorkers(String provisionerId, String workerType) throws APICallFailure
Get a list of all active workers of a workerType.
listWorkers allows a response to be filtered by quarantined and non quarantined workers. To filter the query, you should call the end-point with quarantined 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.
public CallSummary<EmptyPayload,WorkerResponse> getWorker(String provisionerId, String workerType, String workerGroup, String workerId) throws APICallFailure
Get a worker from a worker-type.
APICallFailurepublic CallSummary<QuarantineWorkerRequest,WorkerResponse> quarantineWorker(String provisionerId, String workerType, String workerGroup, String workerId, QuarantineWorkerRequest payload) throws APICallFailure
Quarantine a worker
Required scopes: queue:quarantine-worker:
APICallFailurepublic CallSummary<WorkerRequest,WorkerResponse> declareWorker(String provisionerId, String workerType, String workerGroup, String workerId, WorkerRequest payload) throws APICallFailure
Declare a worker, supplying some details about it.
declareWorker allows updating one or more properties of a worker as long as the required scopes are possessed.
Required scopes: For property in properties each queue:declare-worker:
APICallFailureCopyright © 2014–2018 Mozilla. All rights reserved.