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#

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HookDefinition.Metadata

Field Summary

Fields

Modifier and Type	Field and Description
String	deadline Deadline of the task, pending and running runs are resolved as failed if not resolved by other means before the deadline.
String	expires Task expiration, time at which task definition and status is deleted.
String	hookGroupId Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 22
String	hookId Max length: 255
HookDefinition.Metadata	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.
TaskTemplate	task See http://schemas.taskcluster.net/hooks/v1/hook-definition.json#/properties/task

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

Deadline of the task, pending and running runs are resolved as failed if not resolved by other means before the deadline. Note, deadline cannot be more than 5 days into the future. Must be specified as A years B months C days D hours E minutes F seconds, though you may leave out zeros. For more details see: taskcluster.fromNow in taskcluster-client

Default: “1 day”

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

expires

public String expires

Task expiration, time at which task definition and status is deleted. Notice that all artifacts for the must have an expiration that is no later than this. Must be specified as A years B months C days D hours E minutes F seconds, though you may leave out zeros. For more details see: taskcluster.fromNow in taskcluster-client

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 HookDefinition.Metadata 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 TaskTemplate task

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

Constructor Detail

HookDefinition

public HookDefinition()