modifyGate

Back to index

Summary

Modifies an existing gate.
projectName
Stringrequired
The name for the project that must be unique among all projects.
stageName
Stringrequired
Name of the stage to which this task belongs to.
gateType
Stringrequired
The type of the gate.
Possible values: "POST", "PRE"
condition
Stringoptional
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
pipelineName
Stringoptional
The name of the pipeline.
precondition
Stringoptional
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.
releaseName
Stringoptional
The name of the release.

Usage

Perl

$cmdr->modifyGate( "test-projectName", # projectName "test-stageName", # stageName "test-gateType" # gateType # optionals );

ectool

ectool modifyGate \ "test-projectName" `# projectName` \ "test-stageName" `# stageName` \ "test-gateType" `# gateType` \ # optionals

Examples

Perl

$cmdr->modifyGate("Default", "Preflight", POST, {pipelineName => "Annual Summary"});

ectool

ectool modifyGate "Default" "Preflight" POST --pipelineName "Annual Summary"