Groovy API reference

Process

5 minute readReference

createProcess

Creates a new process for an application or component.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

processName

String

(Required) The name of the process.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

If specified, the component is scoped to this application not the project.

componentName

String

The name of the component, if the process is owned by a component.

credentialName

String

The name of a credential to attach to this process.

description

String

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

exclusiveEnvironment

Boolean

True if environment is exclusive to the application or service process.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

The name of the microservice, if the process is owned by a microservice.

processType

ProcessType

Defines type of action performed by the process.

smartUndeployEnabled

Boolean

True if smart deploy should be enabled for the undeploy component process.

timeLimit

String

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

TimeLimitUnits

Units for step time limit: seconds, minutes, or hours.

workingDirectory

String

Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job’s workspace.

workspaceName

String

The name of the default workspace for this process.

Positional arguments

projectName, processName

Usage

ec-perl

$cmdr->createProcess(<projectName>, <processName>, {<optionals>});

ectool

ectool createProcess projectName processName [optionals]

deleteProcess

Deletes an application or component process.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

processName

String

(Required) The name of the process.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

If specified, the component is scoped to this application not the project.

componentName

String

The name of the component, if the process is owned by a component.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

The name of the microservice, if the process is owned by a microservice.

Positional arguments

projectName, processName

Usage

ec-perl

$cmdr->deleteProcess(<projectName>, <processName>, {<optionals>});

ectool

ectool deleteProcess projectName processName [optionals]

getProcess

Retrieves an application or component process.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

processName

String

(Required) The name of the process.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

If specified, the component is scoped to this application not the project.

componentName

String

The name of the component, if the process is owned by a component.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

The name of the microservice, if the process is owned by a microservice.

Positional arguments

projectName, processName

Usage

ec-perl

$cmdr->getProcess(<projectName>, <processName>, {<optionals>});

ectool

ectool getProcess projectName processName [optionals]

getProcesses

Retrieves all processes in an application or component.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationEntityRevisionId

UUID

The revision ID of the versioned object.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

If specified, the component is scoped to this application not the project.

componentName

String

The name of the component, if the process is owned by a component.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

The name of the microservice, if the process is owned by a microservice.

Positional arguments

projectName

Usage

ec-perl

$cmdr->getProcesses(<projectName>, {<optionals>});

ectool

ectool getProcesses projectName [optionals]

modifyProcess

Modifies an existing process.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

processName

String

(Required) The name of the process.

applicationName

String

The name of the application, if the process is owned by an application.

componentApplicationName

String

If specified, the component is scoped to this application not the project.

componentName

String

The name of the component, if the process is owned by a component.

credentialName

String

The name of a credential to attach to this process.

description

String

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

exclusiveEnvironment

Boolean

True if environment is exclusive to the application or service process.

microserviceApplicationName

String

If specified, the microservice is scoped to an application.

microserviceName

String

The name of the microservice, if the process is owned by a microservice.

newName

String

The new name for an existing object that is being renamed.

processType

ProcessType

Defines type of action performed by the process.

smartUndeployEnabled

Boolean

True if smart deploy should be enabled for the undeploy component process.

timeLimit

String

Maximum amount of time the step can execute; abort if it exceeds this time.

timeLimitUnits

TimeLimitUnits

Units for step time limit: seconds, minutes, or hours.

workingDirectory

String

Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job’s workspace.

workspaceName

String

The name of the default workspace for this process.

Positional arguments

projectName, processName

Usage

ec-perl

$cmdr->modifyProcess(<projectName>, <processName>, {<optionals>});

ectool

ectool modifyProcess projectName processName [optionals]

runProcess

Runs the specified process. For microservice applications, it is used to deploy a microservice to a Kubernetes cluster.

Arguments

Argument Name Type Description

projectName

String

(Required) The name for the project that must be unique among all projects.

applicationName

String

(Required) The name of the application that owns the process.

processName

String

(Required) The name of the application process.

actualParameters

Map

Parameters passed as arguments to the process.

credentialReferenceParameters

Map

List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime.

credentials

Collection

Credentials to be used in the job.

destinationProject

String

The project that will own the job.

enforceDependencies

Boolean

If application dependencies are defined for the specified application, enforce them for successful deployment.

environmentName

String

Environment name to create from template.

environmentProjectName

String

The name of the project to which the environment or environment template belongs to.

environmentTemplateName

String

Environment template name.

environmentTemplateProjectName

String

The name of the project to which the environment template belongs to.

environmentTemplateTierMapName

String

Environment template tier map name.

keepOnError

Boolean

True to keep environment on error (default is false).

parsedWebhookData

String

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

priority

JobPriority

The priority of the job.

rollingDeployEnabled

Boolean

Perform rolling deployment.

rollingDeployManualStepAssignees

Collection

A list of assignees who receive the notification when rolling deploy iteration completes.

rollingDeployManualStepCondition

NotificationType

Defines run condition on manual step created during rolling deployment.

rollingDeployPhases

Collection

One or more rolling deploy phases to be used for deployment.

rolloutApprovers

Collection

A list of rollout approvers.

rolloutNotificationEnabled

Boolean

Rollout notification enabled (default is false).

scheduleName

String

Name for the schedule; must be unique among all schedules for the project.

smartDeploy

Boolean

Smart deploy — if provided actual param will be overridden.

snapshotName

String

Name for the snapshot.

stageArtifacts

Boolean

Stage all artifacts being deployed as part of the application process.

tierMapName

String

The name of the tier map used to determine where to run the process.

tierResourceCounts

Map

Resource count per resource template tier.

validate

Boolean

Validate the process and environment.

webhookData

String

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

String

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Positional arguments

projectName, applicationName, processName

Usage

ec-perl

$cmdr->runProcess(<projectName>, <applicationName>, <processName>, {<optionals>});

ectool

ectool runProcess projectName applicationName processName [optionals]