modifyEnvironmentInventoryItem

Back to index

Summary

Modifies an existing environment 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.

applicationTierName

Stringoptional

Name of the application tier.

artifactSource

Stringoptional

Source of the artifact.

artifactUrl

Stringoptional

Url of the artifact. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].

artifactVersion

Stringoptional

Artifact version for the inventory item.

componentName

Stringoptional

Component that owns the inventory item.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

environmentProjectName

Stringoptional

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

resourceName

Stringoptional

Resource where the item is installed.

status

Stringoptional

Inventory deployment status.

Possible values: "success", "warning", "error", "skipped", "notRun"

Usage

Groovy

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

ElectricFlow ef = new ElectricFlow()

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