Flow API guide
IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
Perl API Commands
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory Provider ManagementDynamic EnvironmentsEmail Configuration ManagementEmail Notifier ManagementEnvironmentEnvironment TierGateway and Zone ManagementInstalling or Upgrading Remote AgentsJob ManagementMicroservicesObject TagsParameter ManagementPersonasPipelines and ReleasesPlugin ManagementProcedure ManagementProcessProcess DependencyProcess StepProject ManagementProperty ManagementResource ManagementRolling DeploySchedule ManagementServer ManagementSingle Sign-OnSnapshotsTier MapUser and Group ManagementWait DependenciesWebhhook ManagementWorkflow Definition ManagementWorkflow ManagementWork ItemsWorkspace ManagementMiscellaneous Management
Groovy API guide
IntroductionExamples
Groovy API commands
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

Container commands

3 minute readReference

createContainer

Creates a new container for a project or service.

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

Name for the container; must be unique within the project or service. (Required)

applicationName

String

The name of an application containing the specified service.

command

String

command to run on the container

cpuCount

String

number of CPUs to allocate to the container

cpuLimit

String

maximum number of CPUs

credentialName

String

The name of a credential to be used for accessing specified registry.

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

entryPoint

String

entrypoint for the container

imageName

String

Name of the container image

imageVersion

String

Version of the container image

memoryLimit

String

Memory limit in MB

memorySize

String

Size of memory in MB

registryUri

String

Registry uri of the container image

serviceName

String

The name of service containing the specified container.

volumeMount

String

Volume mount json of the container image

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteContainer

Deletes a container

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

Name for the container; must be unique within the project or service. (Required)

applicationName

String

The name of an application containing the specified service.

serviceName

String

The name of service containing the specified container.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getContainer

Find a container by name.

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

Name for the container; must be unique within the project or service. (Required)

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

The name of an application containing the specified service.

includeDetails

Boolean

True to include details (default is false)

serviceName

String

The name of service containing the specified container.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getContainers

Retrieve all containers in a project or service.

Arguments

Argument NameTypeDescription

projectName

String

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

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationName

String

Name of the application containing the specified service.

includeDetails

Boolean

True to include details (default is false)

serviceName

String

The name of service containing the specified container.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

modifyContainer

Modifies an existing container.

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

Name for the container; must be unique within the project or service. (Required)

applicationName

String

The name of an application containing the specified service.

command

String

command to run on the container

cpuCount

String

number of CPUs to allocate to the container

cpuLimit

String

maximum number of CPUs

credentialName

String

The name of a credential to be used for accessing specified registry.

description

String

Comment text describing this object that is not interpreted at all by CloudBees Flow.

entryPoint

String

entrypoint for the container

imageName

String

Name of the container image

imageVersion

String

Version of the container image

memoryLimit

String

Memory limit in MB

memorySize

String

Size of memory in MB

newName

String

New name for an existing object that is being renamed.

registryUri

String

Registry uri of the container image

serviceName

String

The name of service containing the specified container.

volumeMount

String

Volume mount json of the container image

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyContainer(
                projectName: 'test-projectName',
                containerName: 'test-containerName'
                /* optional arguments */)
component
credential