org.mozilla.taskcluster.client.hooks

Class HookDefinition

java.lang.Object

org.mozilla.taskcluster.client.hooks.HookDefinition

public class HookDefinition
extends Object

Definition of a hook that will create tasks when defined events occur.

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#

Field Summary

Fields

Modifier and Type	Field and Description
String	deadline Use of this field is deprecated; use deadline: {$fromNow: ..}
String	expires Use of this field is deprecated; use expires: {$fromNow: ..}
String	hookGroupId Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/hookGroupId
String	hookId Max length: 255See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/hookId
HookMetadata	metadata See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/metadata
Object	schedule Definition of the times at which a hook will result in creation of a task.
Object	task Template for the task definition.
Object	triggerSchema See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/triggerSchema

Constructor Summary

Constructors

Constructor and Description
HookDefinition()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

deadline

public String deadline

Use of this field is deprecated; use deadline: {$fromNow: ..} in the task template instead.

Default: “1 day”

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/deadline

expires

public String expires

Use of this field is deprecated; use expires: {$fromNow: ..} in the task template instead.

Default: “3 months”

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/expires

hookGroupId

public String hookGroupId

Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/hookGroupId

hookId

public String hookId

Max length: 255

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/hookId

metadata

public HookMetadata metadata

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/metadata

schedule

public Object schedule

Definition of the times at which a hook will result in creation of a task. If several patterns are specified, tasks will be created at any time specified by one or more patterns. Note that tasks may not be created at exactly the time specified. {$ref: "http://schemas.taskcluster.net/hooks/v1/schedule.json#"}

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/schedule

task

public Object task

Template for the task definition. This is rendered using JSON-e as described in https://docs.taskcluster.net/reference/core/taskcluster-hooks/docs/firing-hooks to produce a task definition that is submitted to the Queue service.

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/task

triggerSchema

public Object triggerSchema

See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/triggerSchema

Constructor Detail

HookDefinition

public HookDefinition()