org.mozilla.taskcluster.client.hooks

Class Hooks

java.lang.Object

org.mozilla.taskcluster.client.TaskClusterRequestHandler

org.mozilla.taskcluster.client.hooks.Hooks

public class Hooks
extends TaskClusterRequestHandler

Hooks are a mechanism for creating tasks in response to events.

Hooks are identified with a hookGroupId and a hookId.

When an event occurs, the resulting task is automatically created. The task is created using the scope assume:hook-id:<hookGroupId>/<hookId>, which must have scopes to make the createTask call, including satisfying all scopes in task.scopes.

Hooks can have a ‘schedule’ indicating specific times that new tasks should be created. Each schedule is in a simple cron format, per https://www.npmjs.com/package/cron-parser. For example: * ["0 0 1 * * *"] – daily at 1:00 UTC * ["0 0 9,21 * * 1-5", "0 0 12 * * 0,6"] – weekdays at 9:00 and 21:00 UTC, weekends at noon

See: http://docs.taskcluster.net/services/hooks

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Hooks()
Hooks(String baseURL)
Hooks(String clientId, String accessToken)
Hooks(String clientId, String accessToken, String certificate)

Method Summary

Modifier and Type	Method and Description
CallSummary<HookCreationRequest,HookDefinition>	createHook(String hookGroupId, String hookId, HookCreationRequest payload) This endpoint will create a new hook.
CallSummary<EmptyPayload,HookScheduleResponse>	getHookSchedule(String hookGroupId, String hookId) This endpoint will return the schedule and next scheduled creation time for the given hook.
CallSummary<EmptyPayload,HookStatusResponse>	getHookStatus(String hookGroupId, String hookId) This endpoint will return the current status of the hook.
CallSummary<EmptyPayload,HookDefinition>	hook(String hookGroupId, String hookId) This endpoint will return the hook defintion for the given hookGroupId and hookId.
CallSummary<EmptyPayload,HookGroups>	listHookGroups() This endpoint will return a list of all hook groups with at least one hook.
CallSummary<EmptyPayload,HookList>	listHooks(String hookGroupId) This endpoint will return a list of all the hook definitions within a given hook group.
CallSummary<EmptyPayload,EmptyPayload>	removeHook(String hookGroupId, String hookId) This endpoint will remove a hook definition.
CallSummary<HookCreationRequest,HookDefinition>	updateHook(String hookGroupId, String hookId, HookCreationRequest payload) This endpoint will update an existing hook.

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler

apiCall, configureHawk, setBaseURL, uriEncode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultBaseURL

protected static final String defaultBaseURL

See Also:

Constant Field Values

Constructor Detail

Hooks

public Hooks(String clientId,
             String accessToken)

Hooks

public Hooks(String clientId,
             String accessToken,
             String certificate)

Hooks

public Hooks(String baseURL)

Hooks

public Hooks()

Method Detail

listHookGroups

public CallSummary<EmptyPayload,HookGroups> listHookGroups()
                                                    throws APICallFailure

This endpoint will return a list of all hook groups with at least one hook.

See http://docs.taskcluster.net/services/hooks/#listHookGroups

Throws:

APICallFailure

listHooks

public CallSummary<EmptyPayload,HookList> listHooks(String hookGroupId)
                                             throws APICallFailure

This endpoint will return a list of all the hook definitions within a given hook group.

See http://docs.taskcluster.net/services/hooks/#listHooks

Throws:

APICallFailure

hook

public CallSummary<EmptyPayload,HookDefinition> hook(String hookGroupId,
                                                     String hookId)
                                              throws APICallFailure

This endpoint will return the hook defintion for the given hookGroupId and hookId.

See http://docs.taskcluster.net/services/hooks/#hook

Throws:

APICallFailure

getHookStatus

public CallSummary<EmptyPayload,HookStatusResponse> getHookStatus(String hookGroupId,
                                                                  String hookId)
                                                           throws APICallFailure

This endpoint will return the current status of the hook. This represents a snapshot in time and may vary from one call to the next.

See http://docs.taskcluster.net/services/hooks/#getHookStatus

Throws:

APICallFailure

getHookSchedule

public CallSummary<EmptyPayload,HookScheduleResponse> getHookSchedule(String hookGroupId,
                                                                      String hookId)
                                                               throws APICallFailure

This endpoint will return the schedule and next scheduled creation time for the given hook.

See http://docs.taskcluster.net/services/hooks/#getHookSchedule

Throws:

APICallFailure

createHook

public CallSummary<HookCreationRequest,HookDefinition> createHook(String hookGroupId,
                                                                  String hookId,
                                                                  HookCreationRequest payload)
                                                           throws APICallFailure

This endpoint will create a new hook.

The caller’s credentials must include the role that will be used to create the task. That role must satisfy task.scopes as well as the necessary scopes to add the task to the queue.

See http://docs.taskcluster.net/services/hooks/#createHook

Throws:

APICallFailure

updateHook

public CallSummary<HookCreationRequest,HookDefinition> updateHook(String hookGroupId,
                                                                  String hookId,
                                                                  HookCreationRequest payload)
                                                           throws APICallFailure

This endpoint will update an existing hook. All fields except hookGroupId and hookId can be modified.

See http://docs.taskcluster.net/services/hooks/#updateHook

Throws:

APICallFailure

removeHook

public CallSummary<EmptyPayload,EmptyPayload> removeHook(String hookGroupId,
                                                         String hookId)
                                                  throws APICallFailure

This endpoint will remove a hook definition.

See http://docs.taskcluster.net/services/hooks/#removeHook

Throws:

APICallFailure