findArtifactVersions

On this page
Back to index

Summary

This command returns the most current artifact version that matches the filter criteria and its dependent artifact versions. This API implicitly searches for artifact versions in the available state, and if run in a job step, registers the step as a retriever for the returned artifact versions.
artifactKey
Stringoptional
The artifactKey component of the GAV (GroupId/ArtifactVersionId/Version) coordinates.
artifactName
Stringoptional
The name of the artifact containing the artifactVersion.
artifactVersionName
Stringoptional
The name of the artifactVersion to find.
filters
Array<Filter>optional
A list of zero or more filter criteria definitions used to define objects to find.
groupId
Stringoptional
The groupId component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. Defaults to the name of the project that owns the requesting job-step, if there is one. Otherwise, this is a required argument.
includeDependents
Booleanoptional
Whether to include dependent artifact versions in results.
jobStepId
Stringoptional
If the retriever is a job-step, it gets registered as a consumer of the result artifactVersion.
versionRange
Stringoptional
Optional version range, specified in interval notation.

Usage

Groovy

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