org.mozilla.taskcluster.client.hooks

Class HookCreationRequest

java.lang.Object

org.mozilla.taskcluster.client.hooks.HookCreationRequest

public class HookCreationRequest
extends Object

Definition of a hook that can create tasks at defined times.

See http://schemas.taskcluster.net/hooks/v1/create-hook-request.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: 64See http://schemas.taskcluster.net/hooks/v1/create-hook-request.json#/properties/hookGroupId
String	hookId Syntax: ^([a-zA-Z0-9-_]*)$ Min length: 1 Max length: 64See http://schemas.taskcluster.net/hooks/v1/create-hook-request.json#/properties/hookId
HookMetadata	metadata See http://schemas.taskcluster.net/hooks/v1/create-hook-request.json#/properties/metadata
String[]	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 Default: { “additionalProperties”: false, “type”: “object” }See http://schemas.taskcluster.net/hooks/v1/create-hook-request.json#/properties/triggerSchema

Constructor Summary

Constructors

Constructor and Description
HookCreationRequest()

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/create-hook-request.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/create-hook-request.json#/properties/expires

hookGroupId

public String hookGroupId

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

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

hookId

public String hookId

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

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

metadata

public HookMetadata metadata

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

schedule

public String[] 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.

Default: []

See http://schemas.taskcluster.net/hooks/v1/create-hook-request.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/create-hook-request.json#/properties/task

triggerSchema

public Object triggerSchema

Default: { “additionalProperties”: false, “type”: “object” }

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

Constructor Detail

HookCreationRequest

public HookCreationRequest()