Groovy API reference

DeploymentHistoryItem

2 minute readReference

getDeploymentHistoryItems

Retrieve all deployment history items for a given environment

Arguments

Argument NameTypeDescription

projectName

String

Deprecated: Deprecated due to microservice model changes Name for the project; must be unique among all projects.

environmentName

String

The name of the environment.

applicationName

String

Application that owns the deployment history item

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

latest

Boolean

Return only latest deployment information

processName

String

Process that owns the deployment history item

serviceName

String

Deprecated: Deprecated due to microservice model changes Service that owns the deployment history item

snapshotName

String

Snapshot that owns the deployment history item

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getDeploymentHistoryItems(
                /* optional arguments */)

seedEnvironmentInventory

Creates a new environment

Arguments

Argument NameTypeDescription

projectName

String

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

environmentName

String

The name of the environment. (Required)

applicationName

String

Applications that owns the inventory item (Required)

applicationProcessName

String

Application process used to deploy to the environment. (Required)

status

String

Inventory deployment status (Required)

applicationTierName

String

The name of the application tier

artifactName

String

Artifact name for the inventory item

artifactProviderSource

String

Source of the provider that indirectly owns this artifact

artifactSource

String

Source of the artifact

artifactUrl

String

Url of the artifact

artifactVersion

String

Artifact version for the inventory item

clusterName

String

Cluster where the item is installed

clusterNamespace

String

Cluster namespace where the item is installed

componentName

String

Component that owns the inventory item

environmentProjectName

String

Name for the project to which the environment or environment template belongs to.

microserviceDeploymentData

String

The deployment details related to a microservice deployment

microserviceDeploymentSummary

String

The summary of microservice deployment

microserviceName

String

Microservice that owns the inventory item

releaseName

String

Name of the release

releaseProjectName

String

Name of the release project

resourceNames

String array

Collections

seeded

Boolean

Seeded status

snapshotName

String

Name of a snapshot

stageName

String

Name of the stage

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.seedEnvironmentInventory(
                projectName: 'test-projectName',
                environmentName: 'test-environmentName',
                applicationName: 'test-applicationName',
                applicationProcessName: 'test-applicationProcessName',
                status: 'test-status'
                /* optional arguments */)