Index
modifyEnvTemplTierResourceTemplMapping
getPluginCatalog
getResourceUsage
getRetrievedArtifacts
runDiscovery
getServerSettings
getServerSettingsCategories
revokeToken
getWorkItems
ActionParameterActualParameterAdditionalFilterAttributeDataTypeAttributePathCfgMgrParameterCloudProviderParameterColorComponentVersionCredentialCredentialReferenceParameterDefinitionParameterDefinitionSourceParameterDeployParameterDestinationMappingExportParameterFieldFilterFormParameterHookActualParameterHookParameterImportParameterLinkParameterOptionPipelineParameterPluginParameterProvisionParameterReleaseFlowRuntimeMappingResourcePhaseMappingResourcePoolPhaseMappingRollbackParameterSelectSortTierMappingTierResourceCountVisualizationProperty

attachParameter

On this page
Back to index

Summary

Attach a formal parameter to a step.
projectName
Stringrequired
The name for the project that must be unique among all projects.
procedureName
Stringoptional
The name of the procedure.
stepName
Stringoptional
The name of the step in the procedure.
formalParameterName
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.
componentApplicationName
Stringoptional
The name of the component in the application.
componentName
Stringoptional
The name of the component.
gateType
Stringoptional
The type of the gate.
Possible values: "POST", "PRE"
microserviceApplicationName
Stringoptional
The name of the microservice application.
microserviceName
Stringoptional
The name of the microservice.
pipelineName
Stringoptional
The name of the pipeline.
processName
Stringoptional
The name of the process.
processStepName
Stringoptional
The name of the step in the process.
releaseName
Stringoptional
The name of the release, if attaching a credential to a release pipeline.
stageName
Stringoptional
Name of the stage to which this task belongs to.
stateDefinitionName
Stringoptional
The name of the workflow state definition, if attaching a parameter to a state definition.
taskName
Stringoptional
The name of the task.
workflowDefinitionName
Stringoptional
The name of the workflow definition, if attaching a parameter to a workflow state definition.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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