deleteEnvironmentInventoryItem

Back to index

Summary

Deletes an inventory item.

projectName

Stringrequired

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

environmentName

Stringrequired

The name of the environment.

applicationName

Stringoptional

Application that owns the inventory item.

microserviceName

Stringoptional

Service that owns the inventory item.

artifactName

Stringoptional

Artifact name for the inventory item.

clusterName

Stringoptional

Cluster where the item is installed.

artifactVersion

Stringoptional

Artifact version for the inventory item.

componentName

Stringoptional

Component that owns the inventory item.

deploymentStrategyLabel

Stringoptional

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

Stringoptional

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

resourceName

Stringoptional

Resource where the item is installed.

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

def result = ef.deleteEnvironmentInventoryItem(
  projectName: "test-projectName",
  environmentName: "test-environmentName"
  /* optional arguments */
)▼