createHook

Summary

Creates a hook in a resource template, which can have one or more hooks. A hook stores a reference to a procedure in a CloudBees CD/RO project or plugin project. When a resource template is used to create a resource pool, these procedures are invoked.

projectName

Stringoptional

ProjectName of the entity that owns the hook.

procedureName

Stringoptional

Hook procedure name.

hookName

Stringrequired

Name for the hook; must be unique among all hooks.

broadcast

Booleanoptional

Broadcast flag.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

hookParameters

Array<HookParameter>optional

Hook parameters.

hookType

Stringoptional

Hook type.

Possible values: "POST_CONFIGURATION", "POST_PROVISIONING", "POST_TEARDOWN", "PRE_CONFIGURATION", "PRE_PROVISIONING", "PRE_TEARDOWN"

procedurePluginKey

Stringoptional

Procedure plugin key.

procedureProjectName

Stringoptional

Procedure project name.

resourceTemplateName

Stringoptional

Name of the resource template.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createHook(
  hookName: "test-hookName"
  /* optional arguments */
)▼