createFormalOutputParameter

Back to index

Summary

Creates a new formal output parameter.

projectName

Stringrequired

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

formalOutputParameterName

Stringrequired

Name for this parameter; used when the procedure is invoked to specify a value for the parameter.

applicationName

Stringoptional

The name of the application, if the formal output parameter is on an application process.

description

Stringoptional

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

pipelineName

Stringoptional

The name of the pipeline, if the formal output parameter is on a pipeline.

procedureName

Stringoptional

The name of the procedure.

processName

Stringoptional

The name of the process, if the formal output parameter is on a process.

releaseName

Stringoptional

The name of the release, where pipeline is located.

Usage

Perl

$cmdr->createFormalOutputParameter(
  "test-projectName", # projectName
  "test-formalOutputParameterName" # formalOutputParameterName
  # optionals
);▼

ectool

ectool createFormalOutputParameter \
  "test-projectName" `# projectName` \
  "test-formalOutputParameterName" `# formalOutputParameterName` \
  # optionals▼

Examples

Perl

$cmdr->createFormalOutputParameter("Sample Project", "Branch Name",
  {procedureName => testProcedure });▼

ectool

ectool createFormalOutputParameter "Sample Project" "Branch Name"
  --procedureName testProcedure▼