createFormalOutputParameter
Create a new formal output parameter.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
formalOutputParameterName | String | Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required) |
pipelineName | String | The name of the pipeline, if the formal output parameter is on a pipeline. |
applicationName | String | The name of the application, if the formal output parameter is on an application process. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
procedureName | String | The name of the procedure. |
processName | String | The name of the process, if the formal output parameter is on a process. |
releaseName | String | The name of the release, where pipeline is located. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.createFormalOutputParameter(
projectName: 'test-projectName',
formalOutputParameterName: 'test-formalOutputParameterName'
/* optional arguments */)
deleteFormalOutputParameter
Delete a formal output parameter.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
formalOutputParameterName | String | Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required) |
pipelineName | String | The name of the pipeline, if the formal output parameter is on a pipeline. |
applicationName | String | The name of the application, if the formal output parameter is on an application process. |
procedureName | String | The name of the procedure. |
processName | String | The name of the process, if the formal output parameter is on a process. |
releaseName | String | The name of the release, where pipeline is located. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.deleteFormalOutputParameter(
projectName: 'test-projectName',
formalOutputParameterName: 'test-formalOutputParameterName'
/* optional arguments */)
getFormalOutputParameter
Get a formal output parameter by name.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
formalOutputParameterName | String | Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required) |
pipelineName | String | The name of the pipeline, if the formal output parameter is on a pipeline. |
applicationName | String | The name of the application, if the formal output parameter is on an application process. |
procedureName | String | The name of the procedure. |
processName | String | The name of the process, if the formal output parameter is on a process. |
releaseName | String | The name of the release, where pipeline is located. |
Usage
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 */)
getFormalOutputParameters
Get all formal output parameters from an output parameter container
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
pipelineName | String | The name of the pipeline, if the formal output parameter is on a pipeline. |
applicationName | String | The name of the application, if the formal output parameter is on an application process. |
procedureName | String | The name of the procedure. |
processName | String | The name of the process, if the formal output parameter is on a process. |
releaseName | String | The name of the release, where pipeline is located. |
modifyFormalOutputParameter
Modify an existing formal output parameter.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
formalOutputParameterName | String | Name for this parameter; used when the procedure is invoked to specify a value for the parameter. (Required) |
pipelineName | String | The name of the pipeline, if the formal output parameter is on a pipeline. |
applicationName | String | The name of the application, if the formal output parameter is on an application process. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName | String | New name for an existing object that is being renamed. |
procedureName | String | The name of the procedure. |
processName | String | The name of the process, if the formal output parameter is on a process. |
releaseName | String | The name of the release, where pipeline is located. |
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.modifyFormalOutputParameter(
projectName: 'test-projectName',
formalOutputParameterName: 'test-formalOutputParameterName'
/* optional arguments */)