| Modifier and Type | Method and Description |
|---|---|
protected <Request,Response> |
TaskClusterRequestHandler.apiCall(Request payload,
String method,
String route,
Type responseType) |
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,AWSS3CredentialsResponse> |
Auth.awsS3Credentials(String level,
String bucket,
String prefix)
Get temporary AWS credentials for
read-write or read-only access to a given bucket and prefix within that bucket. |
CallSummary<EmptyPayload,AzureSharedAccessSignatureResponse> |
Auth.azureTableSAS(String account,
String table)
Get a shared access signature (SAS) string for use with a specific Azure Table Storage table.
|
CallSummary<EmptyPayload,GetClientResponse> |
Auth.client(String clientId)
Returns all information about a given client.
|
CallSummary<GetClientCredentialsResponse1,GetClientResponse> |
Auth.createClient(String clientId,
GetClientCredentialsResponse1 payload)
Create a client with given
clientId, name, expires, scopes and description. |
CallSummary<EmptyPayload,ExportedClients[]> |
Auth.exportClients()
Export all clients except the root client, as a JSON list.
|
CallSummary<EmptyPayload,GetClientCredentialsResponse> |
Auth.getCredentials(String clientId)
Returns the client’s
accessToken as needed for verifying signatures. |
CallSummary<ExportedClients,ExportedClients[]> |
Auth.importClients(ExportedClients payload)
Import client from JSON list, overwriting any clients that already exists.
|
CallSummary<EmptyPayload,ListClientsResponse[]> |
Auth.listClients()
Return a list of all clients, not including their access tokens.
|
CallSummary<GetClientCredentialsResponse1,GetClientResponse> |
Auth.modifyClient(String clientId,
GetClientCredentialsResponse1 payload)
Modify client
name, expires, scopes and description. |
CallSummary<EmptyPayload,EmptyPayload> |
Auth.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.removeClient(String clientId)
Delete a client with given
clientId. |
CallSummary<EmptyPayload,GetClientResponse> |
Auth.resetCredentials(String clientId)
Reset credentials for a client.
|
CallSummary<EmptyPayload,GetClientScopesResponse> |
Auth.scopes(String clientId)
Returns the scopes the client is authorized to access and the date-time when the clients authorization is set to expire.
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.apiReference()
Get an API reference!
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.awsState()
DEPRECATED.
|
CallSummary<GetSecretRequest,EmptyPayload> |
AwsProvisioner.createSecret(String token,
GetSecretRequest payload)
Insert a secret into the secret storage.
|
CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest> |
AwsProvisioner.createWorkerType(String workerType,
CreateWorkerTypeRequest payload)
Create a worker type and ensure that all EC2 regions have the required KeyPair
|
CallSummary<EmptyPayload,Object> |
AwsProvisioner.getLaunchSpecs(String workerType)
Return the EC2 LaunchSpecifications for all combinations of regions and instance types or a list of reasons why the launch specifications are not valid
|
CallSummary<EmptyPayload,GetSecretResponse> |
AwsProvisioner.getSecret(String token)
Retreive a secret from storage.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.instanceStarted(String instanceId,
String token)
An instance will report in by giving its instance id as well as its security token.
|
CallSummary<EmptyPayload,String[]> |
AwsProvisioner.listWorkerTypes()
List all known WorkerType names
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeSecret(String token)
Remove a secret.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeWorkerType(String workerType)
Delete a WorkerType definition, submits requests to kill all instances and delete the KeyPair from all configured EC2 regions
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.state(String workerType)
Return the state of a given workertype as stored by the provisioner.
|
CallSummary<CreateWorkerTypeRequest,GetWorkerTypeRequest> |
AwsProvisioner.updateWorkerType(String workerType,
CreateWorkerTypeRequest payload)
Update a workerType and ensure that all regions have the require KeyPair
|
CallSummary<EmptyPayload,GetWorkerTypeRequest> |
AwsProvisioner.workerType(String workerType)
Retreive a WorkerType definition
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
Index.findArtifactFromTask(String namespace,
String name)
Find task by namespace and redirect to artifact with given
name, if no task existing for the given namespace, this API end-point respond 404. |
CallSummary<EmptyPayload,IndexedTaskResponse> |
Index.findTask(String namespace)
Find task by namespace, if no task existing for the given namespace, this API end-point respond
404. |
CallSummary<InsertTaskRequest,IndexedTaskResponse> |
Index.insertTask(String namespace,
InsertTaskRequest payload)
Insert a task into the index.
|
CallSummary<ListNamespacesRequest,ListNamespacesResponse> |
Index.listNamespaces(String namespace,
ListNamespacesRequest payload)
List the namespaces immediately under a given namespace.
|
CallSummary<ListTasksRequest,ListTasksResponse> |
Index.listTasks(String namespace,
ListTasksRequest payload)
List the tasks immediately under a given namespace.
|
CallSummary<EmptyPayload,EmptyPayload> |
Index.ping()
Documented later…
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
PurgeCache.ping()
Documented later…
|
CallSummary<PurgeCacheRequest,EmptyPayload> |
PurgeCache.purgeCache(String provisionerId,
String workerType,
PurgeCacheRequest payload)
Publish a purge-cache message to purge caches named
cacheName with provisionerId and workerType in the routing-key. |
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.cancelTask(String taskId)
This method will cancel a task that is either
unscheduled, pending or running. |
CallSummary<TaskClaimRequest,TaskClaimResponse> |
Queue.claimTask(String taskId,
String runId,
TaskClaimRequest payload)
claim a task, more to be added later…
|
CallSummary<Object,Object> |
Queue.createArtifact(String taskId,
String runId,
String name,
Object payload)
This API end-point creates an artifact for a specific run of a task.
|
CallSummary<TaskDefinition,TaskStatusResponse> |
Queue.createTask(String taskId,
TaskDefinition 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<TaskDefinition,TaskStatusResponse> |
Queue.defineTask(String taskId,
TaskDefinition payload)
Define a task without scheduling it.
|
CallSummary<EmptyPayload,EmptyPayload> |
Queue.getArtifact(String taskId,
String runId,
String name)
Get artifact by
<name> from a specific run. |
CallSummary<EmptyPayload,EmptyPayload> |
Queue.getLatestArtifact(String taskId,
String name)
Get artifact by
<name> from the last run of a task. |
CallSummary<EmptyPayload,ListArtifactsResponse> |
Queue.listArtifacts(String taskId,
String runId)
Returns a list of artifacts and associated meta-data for a given run.
|
CallSummary<EmptyPayload,ListArtifactsResponse> |
Queue.listLatestArtifacts(String taskId)
Returns a list of artifacts and associated meta-data for the latest run from the given task.
|
CallSummary<EmptyPayload,CountPendingTasksResponse> |
Queue.pendingTasks(String provisionerId,
String workerType)
Documented later… This probably the end-point that will remain after rewriting to azure queue storage…
|
CallSummary<EmptyPayload,EmptyPayload> |
Queue.ping()
Documented later…
|
CallSummary<EmptyPayload,PollTaskUrlsResponse> |
Queue.pollTaskUrls(String provisionerId,
String workerType)
Get a signed URLs to get and delete messages from azure queue.
|
CallSummary<EmptyPayload,TaskClaimResponse> |
Queue.reclaimTask(String taskId,
String runId)
reclaim a task more to be added later…
|
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.reportCompleted(String taskId,
String runId)
Report a task completed, resolving the run as
completed. |
CallSummary<TaskExceptionRequest,TaskStatusResponse> |
Queue.reportException(String taskId,
String runId,
TaskExceptionRequest payload)
Resolve a run as exception.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.reportFailed(String taskId,
String runId)
Report a run failed, resolving the run as
failed. |
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.rerunTask(String taskId)
This method reruns a previously resolved task, even if it was completed.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.scheduleTask(String taskId)
If you have define a task using
defineTask API end-point, then you can schedule the task to be scheduled using this method. |
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.status(String taskId)
Get task status structure from
taskId |
CallSummary<EmptyPayload,TaskDefinition1> |
Queue.task(String taskId)
This end-point will return the task-definition.
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<TaskGraphDefinition1,TaskGraphStatusResponse> |
Scheduler.createTaskGraph(String taskGraphId,
TaskGraphDefinition1 payload)
Create a new task-graph, the
status of the resulting JSON is a task-graph status structure, you can find the taskGraphId in this structure. |
CallSummary<TaskGraphDefinition,TaskGraphStatusResponse> |
Scheduler.extendTaskGraph(String taskGraphId,
TaskGraphDefinition payload)
Add a set of tasks to an existing task-graph.
|
CallSummary<EmptyPayload,TaskGraphInfoResponse> |
Scheduler.info(String taskGraphId)
Get task-graph information, this includes the task-graph status structure, along with
metadata and tags, but not information about all tasks. |
CallSummary<EmptyPayload,InspectTaskGraphResponse> |
Scheduler.inspect(String taskGraphId)
Inspect a task-graph, this returns all the information the task-graph scheduler knows about the task-graph and the state of its tasks.
|
CallSummary<EmptyPayload,InspectTaskGraphTaskResponse> |
Scheduler.inspectTask(String taskGraphId,
String taskId)
Inspect a task from a task-graph, this returns all the information the task-graph scheduler knows about the specific task.
|
CallSummary<EmptyPayload,EmptyPayload> |
Scheduler.ping()
Documented later…
|
CallSummary<EmptyPayload,TaskGraphStatusResponse> |
Scheduler.status(String taskGraphId)
Get task-graph status, this will return the task-graph status structure.
|
Copyright © 2014–2015 Mozilla. All rights reserved.