getFormalOutputParameter

Back to index

Summary

Retrieves a formal output parameter by name.

projectName

Stringrequired

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

pipelineName

Stringoptional

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

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.

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

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.getFormalOutputParameter(
  projectName: "test-projectName",
  formalOutputParameterName: "test-formalOutputParameterName"
  /* optional arguments */
)▼