Roadmap to CloudBees CD APIs
IntroductionUsing the Groovy APIUsing JRubyCloudBees CD API error messages
Using DSL
IntroductionGetting started with DSLGenerating DSL scriptsDSL automation as codeDSL editorsTroubleshooting and FAQs
DSL method reference
Using the RESTful API
Using the Perl API
Perl API response and element glossary
Perl API reference
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential 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
Using the Groovy API
IntroductionExamples
Groovy API reference
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

ServiceMapDetail

5 minute readReference

createServiceMapDetail

Adds service map detail to service mapping.

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

The name of the container. (Required)

applicationName

String

The name of the application which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the application service mapping.

actualParameters

array

Actual parameters specific to plugin procedure associated with the container

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

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.

entryPoint

String

entrypoint for the container

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

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

serviceEntityRevisionId

String

Revisionid of the versioned object

serviceMapDetailName

String

The name of the service map detail.

serviceName

String

The name of the independent service.

volumeMount

String

Volume mount json of the container image

Usage

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


ElectricFlow ef = new ElectricFlow()

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

deleteServiceMapDetail

Deletes a service detail map for the given container

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

The name of the container. (Required)

applicationName

String

The name of the application which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the application service mapping.

serviceMapDetailName

String

The name of the service map detail.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

serviceEntityRevisionId

String

Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getServiceMapDetail

Get a service map detail for given container

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

The name of the container. (Required)

applicationName

String

The name of the application which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the application service mapping.

serviceMapDetailName

String

The name of the service map detail.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

includeDetails

Boolean

True to include details (default is false)

serviceEntityRevisionId

String

Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

getServiceMapDetails

Gets all the service map details for a service mapping

Arguments

Argument NameTypeDescription

projectName

String

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

applicationName

String

The name of the application which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the application service mapping.

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

includeDetails

Boolean

True to include details (default is false)

serviceEntityRevisionId

String

Revisionid of the versioned object

serviceName

String

The name of the independent service.

Usage

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


ElectricFlow ef = new ElectricFlow()

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

modifyServiceMapDetail

Modifies service map detail associated with service mapping.

Arguments

Argument NameTypeDescription

projectName

String

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

containerName

String

The name of the container. (Required)

applicationName

String

The name of the application which contains the service.

tierMapName

String

The name of the tier map. If not provided, will use application name and environment name to resolve tierMap.

serviceClusterMappingName

String

The name of the application service mapping.

serviceMapDetailName

String

The name of the service map detail.

actualParameters

array

Actual parameters specific to plugin procedure associated with the container

applicationEntityRevisionId

String

Revisionid of the versioned object

applicationServiceMappingName

String

The name of the application service mapping.

clearActualParameters

Boolean

True if we should remove all actual parameters.

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.

entryPoint

String

entrypoint for the container

environmentMapName

String

The name of the environment map. If not provided, will use service name and environment name to resolve environmentMap.

environmentName

String

The name of the environment which contains the cluster.

environmentProjectName

String

The name of the environment which contains the cluster.

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

serviceEntityRevisionId

String

Revisionid of the versioned object

serviceName

String

The name of the independent service.

volumeMount

String

Volume mount json of the container image

Usage

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


ElectricFlow ef = new ElectricFlow()

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