RollingDeployPhase

createRollingDeployPhase

Adds a rolling deploy phase to the specified environment.

Arguments

Argument Name Type Description

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
rollingDeployPhaseName	String	The name of the rolling deploy phase. (Required)
environmentName	String	The name of the environment.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
orderIndex	Integer	Specifies the phase order (starts from 1).
phaseExpression	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.
rollingDeployPhaseType	String	The type of rolling deploy phase.

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase. (Required)

environmentName

String

The name of the environment.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

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.

rollingDeployPhaseType

String

The type of rolling deploy phase.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createRollingDeployPhase(
                projectName: 'test-projectName',
                rollingDeployPhaseName: 'test-rollingDeployPhaseName'
                /* optional arguments */)▼

getRollingDeployPhase

Retrieves the rolling deploy phase associated with an environment.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
rollingDeployPhaseName	String	The name of the rolling deploy phase. (Required)
environmentName	String	The name of the environment.
environmentTierName	String	Name for the environment tier.
includeResourceCount	Boolean	True to include resource count for rolling deploy phase.

Argument Name

Type

Description

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase. (Required)

environmentName

String

The name of the environment.

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getRollingDeployPhase(
                projectName: 'test-projectName',
                rollingDeployPhaseName: 'test-rollingDeployPhaseName'
                /* optional arguments */)▼

getRollingDeployPhases

Retrieves all rolling deploy phases associated with an environment.

Arguments

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
environmentName	String	The name of the environment.
applicationName	String	Name for the application.
applicationProjectName	String	Name for the application project.
environmentTierName	String	Name for the environment tier.
includeResourceCount	Boolean	True to include resource count for rolling deploy phase.

Argument Name

Type

Description

projectName

String

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

environmentName

String

The name of the environment.

applicationName

String

Name for the application.

applicationProjectName

String

Name for the application project.

environmentTierName

String

Name for the environment tier.

includeResourceCount

Boolean

True to include resource count for rolling deploy phase.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getRollingDeployPhases(
                projectName: 'test-projectName',
                /* optional arguments */)▼

modifyRollingDeployPhase

Modifies the rolling deploy phase associated with an environment.

Arguments

Argument Name Type Description

Argument Name	Type	Description
projectName	String	The name for the project that must be unique among all projects. (Required)
rollingDeployPhaseName	String	The name of the rolling deploy phase. (Required)
environmentName	String	The name of the environment.
description	String	Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName	String	The new name for an existing object that is being renamed.
orderIndex	Integer	Specifies the phase order (starts from 1).
phaseExpression	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.
rollingDeployPhaseType	String	The type of rolling deploy phase.

projectName

String

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

rollingDeployPhaseName

String

The name of the rolling deploy phase. (Required)

environmentName

String

The name of the environment.

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

The new name for an existing object that is being renamed.

orderIndex

Integer

Specifies the phase order (starts from 1).

phaseExpression

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.

rollingDeployPhaseType

String

The type of rolling deploy phase.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyRollingDeployPhase(
                projectName: 'test-projectName',
                rollingDeployPhaseName: 'test-rollingDeployPhaseName'
                /* optional arguments */)▼