ApplicationTier

3 minute readReference

addComponentToApplicationTier

Adds the specified component to the specified application tier.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

componentName

String

Name of the component. (Required)

componentProjectName

String

Project name of the component.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.addComponentToApplicationTier( projectName: 'test-projectName', applicationName: 'test-applicationName', applicationTierName: 'test-applicationTierName', componentName: 'test-componentName' /* optional arguments */)

createApplicationTier

Creates a new application tier in the application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

description

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createApplicationTier( projectName: 'test-projectName', applicationName: 'test-applicationName', applicationTierName: 'test-applicationTierName' /* optional arguments */)

deleteApplicationTier

Deletes a tier from an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.deleteApplicationTier( projectName: 'test-projectName', applicationName: 'test-applicationName', applicationTierName: 'test-applicationTierName')

getApplicationTier

Retrieves an application tier by name.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getApplicationTier( projectName: 'test-projectName', applicationName: 'test-applicationName', applicationTierName: 'test-applicationTierName' /* optional arguments */)

getApplicationTiers

Retrieves all application tiers in an application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getApplicationTiers( projectName: 'test-projectName', applicationName: 'test-applicationName' /* optional arguments */)

getApplicationTiersInComponent

Retrieves all application tiers that are used by the given component.

Arguments

Argument Name Type Description

projectName

String

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

componentName

String

The name of the component. (Required)

applicationEntityRevisionId

String

The revision ID of the versioned object.

applicationName

String

The name of an application to scope this component to.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getApplicationTiersInComponent( projectName: 'test-projectName', componentName: 'test-componentName' /* optional arguments */)

modifyApplicationTier

Modifies an existing tier in the application.

Arguments

Argument Name Type Description

projectName

String

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

applicationName

String

The name of the application. (Required)

applicationTierName

String

Name of the tier; must be unique within the application. (Required)

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.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyApplicationTier( projectName: 'test-projectName', applicationName: 'test-applicationName', applicationTierName: 'test-applicationTierName' /* optional arguments */)