Artifact

2 minute readReference

createArtifact

Creates a new artifact.

Arguments

Argument Name Type Description

artifactVersionNameTemplate

String

The artifactVersion name template.

description

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.createArtifact( /* optional arguments */)

deleteArtifact

Deletes an existing artifact element and all artifact versions.

Arguments

Argument Name Type Description

artifactName

String

The name of the artifact, compose of the group and artifact concatenated by ':', e.g. "group:artifact". Alternatively, the groupId and artifactKey arguments may be used.

artifactKey

String

The artifactKey component of the GAV (GroupId/ArtifactKey/Version) coordinates.

groupId

String

The groupId component of the GAV (GroupId/ArtifactKey/Version) coordinates.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.deleteArtifact( /* optional arguments */)

getArtifact

Retrieves an artifact by name.

Arguments

Argument Name Type Description

artifactName

String

The name of the artifact, compose of the group and artifact concatenated by ':', e.g. "group:artifact". Alternatively, the groupId and artifactKey arguments may be used.

artifactKey

String

The artifactKey component of the GAV (GroupId/ArtifactKey/Version) coordinates.

groupId

String

The groupId component of the GAV (GroupId/ArtifactKey/Version) coordinates.

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getArtifact( /* optional arguments */)

getArtifacts

Retrieves all artifacts in the system.

Arguments

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.getArtifacts()

modifyArtifact

Modifies an existing artifact.

Arguments

Argument Name Type Description

artifactName

String

The name of the artifact.

artifactVersionNameTemplate

String

The artifactVersion name template.

description

String

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

Usage

import com.electriccloud.client.groovy.ElectricFlow import com.electriccloud.client.groovy.models.* ElectricFlow ef = new ElectricFlow() def result = ef.modifyArtifact( /* optional arguments */)