createGate
Create a new gate for a stage.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
stageName | String | Name of the stage to which this task belongs to. (Required) |
gateType | String | The type of the gate. (Required) |
condition | String | 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 | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
pipelineName | String | The name of the pipeline |
precondition | String | 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 | String | The name of the release |
deleteGate
Delete a gate.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
stageName | String | Name of the stage to which this task belongs to. (Required) |
gateType | String | The type of the gate. (Required) |
pipelineName | String | The name of the pipeline |
releaseName | String | The name of the release |
getGate
Retrieve a gate by stage name and gate type.
Arguments
Argument Name | Type | Description |
---|---|---|
stageName | String | Name of the stage to which this task belongs to. (Required) |
gateType | String | The type of the gate. (Required) |
projectName | String | The name for the project that must be unique among all projects. (Required) |
pipelineName | String | The name of the pipeline |
releaseName | String | The name of the release |
modifyGate
Modifies an existing gate.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
stageName | String | Name of the stage to which this task belongs to. (Required) |
gateType | String | The type of the gate. (Required) |
condition | String | 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 | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
pipelineName | String | The name of the pipeline |
precondition | String | 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 | String | The name of the release |