getDeploymentHistoryItems
Retrieves all the deployment history items for a specific environment.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName |
String |
Deprecated: 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 |
Retrieves only latest deployment history item. Note that response have no deployment history items if there were no environment inventory items associated with the last deployment. |
processName |
String |
Process that owns the deployment history item. |
snapshotName |
String |
Snapshot that owns the deployment history item. |
seedEnvironmentInventory
Seeds the environment with a new inventory to mimic an actual application or release-scoped deployment.
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. (Required) |
applicationName |
String |
Applications that owns the inventory item. (Required) |
status |
String |
Inventory deployment status. (Required) |
applicationProcessName |
String |
Application process used to deploy to the environment. |
applicationTierName |
String |
The name of the application tier. |
applicationVersion |
String |
Application version for the application that was deployed. |
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. |
deploymentDetails |
String |
Additional information about the deployment in JSON format. |
deploymentStrategy |
String |
Deployment strategy used for the deployment of the microservice artifact being added to the environment inventory. (Used exclusively in the context of an advanced deployment strategy for a microservice application). |
deploymentStrategyInProgress |
Boolean |
Whether deployment strategy is in progress. (Used exclusively in the context of an advanced deployment strategy for a microservice application). |
deploymentStrategyLabel |
String |
Label used by microservice plugins EC-Helm and EC-Kubectl to identify deployments depending on the deployment strategy in progress. For example, canary and stable will be used with canary strategy-based deployments while preview and active will be used with bluegreen strategy-based deployments. (Used exclusively in the context of an advanced deployment strategy for a microservice application). |
environmentProjectName |
String |
Name for the project to which the environment or environment template belongs to. |
jobId |
String |
The ID of the job. |
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 |
An array of resource names |
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', status: 'test-status' /* optional arguments */)