| 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)
Get information about a single client.
|
CallSummary<EmptyPayload,SetOfScopes> |
Auth.currentScopes()
Return the expanded scopes available in the request, taking into account all sources of scopes and scope restrictions (temporary credentials, assumeScopes, client scopes, and roles).
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.deleteClient(String clientId)
Delete a client, please note that any roles related to this client must be deleted independently.
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.deleteClient(String clientId)
Delete a client, please note that any roles related to this client must be deleted independently.
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.deleteRole(String roleId)
Delete a role.
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.deleteRole(String roleId)
Delete a role.
|
CallSummary<EmptyPayload,GetClientResponse> |
Auth.disableClient(String clientId)
Disable a client.
|
CallSummary<EmptyPayload,GetClientResponse> |
Auth.enableClient(String clientId)
Enable a client that was disabled with
disableClient. |
CallSummary<EmptyPayload,GetClientResponse[]> |
Auth.listClients()
Get a list of all clients.
|
CallSummary<EmptyPayload,GetRoleResponse[]> |
Auth.listRoles()
Get a list of all roles, each role object also includes the list of scopes it expands to.
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
Auth.ping()
Documented later…
|
CallSummary<EmptyPayload,CreateClientResponse> |
Auth.resetAccessToken(String clientId)
Reset a clients
accessToken, this will revoke the existing accessToken, generate a new accessToken and return it from this call. |
CallSummary<EmptyPayload,GetRoleResponse> |
Auth.role(String roleId)
Get information about a single role, including the set of scopes that the role expands to.
|
CallSummary<EmptyPayload,SentryDSNResponse> |
Auth.sentryDSN(String project)
Get temporary DSN (access credentials) for a sentry project.
|
CallSummary<EmptyPayload,StatsumTokenResponse> |
Auth.statsumToken(String project)
Get temporary
token and baseUrl for sending metrics to statsum. |
CallSummary<EmptyPayload,TestAuthenticateResponse> |
Auth.testAuthenticateGet()
Utility method similar to
testAuthenticate, but with the GET method, so it can be used with signed URLs (bewits). |
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,BackendStatusResponse> |
AwsProvisioner.backendStatus()
This endpoint is used to show when the last time the provisioner has checked in.
|
CallSummary<GetSecretRequest,EmptyPayload> |
AwsProvisioner.createSecret(String token,
GetSecretRequest payload)
Insert a secret into the secret storage.
|
CallSummary<EmptyPayload,Object> |
AwsProvisioner.getLaunchSpecs(String workerType)
This method returns a preview of all possible launch specifications that this worker type definition could submit to EC2.
|
CallSummary<EmptyPayload,GetSecretResponse> |
AwsProvisioner.getSecret(String token)
Retrieve 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,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()
Return a list of string worker type names.
|
CallSummary<EmptyPayload,WorkerTypeSummary[]> |
AwsProvisioner.listWorkerTypeSummaries()
Return a list of worker types, including some summary information about current capacity for each.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeSecret(String token)
Remove a secret.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeSecret(String token)
Remove a secret.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeWorkerType(String workerType)
Delete a worker type definition.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.removeWorkerType(String workerType)
Delete a worker type definition.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.state(String workerType)
Return the state of a given workertype as stored by the provisioner.
|
CallSummary<EmptyPayload,EmptyPayload> |
AwsProvisioner.state(String workerType)
Return the state of a given workertype as stored by the provisioner.
|
CallSummary<EmptyPayload,GetWorkerTypeResponse> |
AwsProvisioner.workerType(String workerType)
Retreive a copy of the requested worker type definition.
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
Github.githubWebHookConsumer()
Capture a GitHub event and publish it via pulse, if it’s a push or pull request.
|
CallSummary<EmptyPayload,EmptyPayload> |
Github.githubWebHookConsumer()
Capture a GitHub event and publish it via pulse, if it’s a push or pull request.
|
CallSummary<EmptyPayload,EmptyPayload> |
Github.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
Github.ping()
Documented later…
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,HookScheduleResponse> |
Hooks.getHookSchedule(String hookGroupId,
String hookId)
This endpoint will return the schedule and next scheduled creation time for the given hook.
|
CallSummary<EmptyPayload,HookStatusResponse> |
Hooks.getHookStatus(String hookGroupId,
String hookId)
This endpoint will return the current status of the hook.
|
CallSummary<EmptyPayload,HookDefinition> |
Hooks.hook(String hookGroupId,
String hookId)
This endpoint will return the hook defintion for the given
hookGroupId and hookId. |
CallSummary<EmptyPayload,HookGroups> |
Hooks.listHookGroups()
This endpoint will return a list of all hook groups with at least one hook.
|
CallSummary<EmptyPayload,HookList> |
Hooks.listHooks(String hookGroupId)
This endpoint will return a list of all the hook definitions within a given hook group.
|
CallSummary<EmptyPayload,EmptyPayload> |
Hooks.removeHook(String hookGroupId,
String hookId)
This endpoint will remove a hook definition.
|
CallSummary<EmptyPayload,EmptyPayload> |
Hooks.removeHook(String hookGroupId,
String hookId)
This endpoint will remove a hook 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,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<EmptyPayload,EmptyPayload> |
Index.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
Index.ping()
Documented later…
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
Login.ping()
Documented later…
|
CallSummary<EmptyPayload,EmptyPayload> |
Login.ping()
Documented later…
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,EmptyPayload> |
PurgeCache.ping()
Documented later…
|
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<EmptyPayload,EmptyPayload> |
Queue.getArtifact(String taskId,
String runId,
String name)
Get artifact by
<name> from a specific run. |
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,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,ListDependentTasksResponse> |
Queue.listDependentTasks(String taskId)
List tasks that depend on the given
taskId. |
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,ListTaskGroupResponse> |
Queue.listTaskGroup(String taskGroupId)
List tasks sharing the same
taskGroupId. |
CallSummary<EmptyPayload,CountPendingTasksResponse> |
Queue.pendingTasks(String provisionerId,
String workerType)
Get an approximate number of pending tasks for the given
provisionerId and workerType. |
CallSummary<EmptyPayload,EmptyPayload> |
Queue.ping()
Documented later…
|
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,TaskReclaimResponse> |
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<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)
scheduleTask will schedule a task to be executed, even if it has unresolved dependencies.
|
CallSummary<EmptyPayload,TaskStatusResponse> |
Queue.status(String taskId)
Get task status structure from
taskId |
CallSummary<EmptyPayload,TaskDefinitionResponse> |
Queue.task(String taskId)
This end-point will return the task-definition.
|
| Modifier and Type | Method and Description |
|---|---|
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,EmptyPayload> |
Scheduler.ping()
Documented later…
|
CallSummary<EmptyPayload,TaskGraphStatusResponse> |
Scheduler.status(String taskGraphId)
Get task-graph status, this will return the task-graph status structure.
|
| Modifier and Type | Method and Description |
|---|---|
CallSummary<EmptyPayload,Secret> |
Secrets.get(String name)
Read the secret associated with some key.
|
CallSummary<EmptyPayload,SecretsList> |
Secrets.list()
List the names of all secrets that you would have access to read.
|
CallSummary<EmptyPayload,EmptyPayload> |
Secrets.ping()
Respond without doing anything.
|
CallSummary<EmptyPayload,EmptyPayload> |
Secrets.ping()
Respond without doing anything.
|
CallSummary<EmptyPayload,EmptyPayload> |
Secrets.remove(String name)
Delete the secret associated with some key.
|
CallSummary<EmptyPayload,EmptyPayload> |
Secrets.remove(String name)
Delete the secret associated with some key.
|
CallSummary<Secret,EmptyPayload> |
Secrets.set(String name,
Secret payload)
Set the secret associated with some key.
|
Copyright © 2014–2016 Mozilla. All rights reserved.