addDependentsToArtifactVersion
Adds a dependent artifact version query to an existing artifact. Dependent artifact versions are retrieved when the parent artifact version is retrieved.
createArtifactVersion
Creates a new artifact version.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactKey | String | The artifactKey component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
artifactName | String | The name of the artifact containing the artifactVersion. |
dependentArtifactVersions | String array | The set of artifactVersions on which this artifactVersion depends. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees Flow. |
groupId | String | The groupId component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
jobStepId | String | The id of the job step; used to make a project association. |
repositoryName | String | The name of the artifact repository. |
version | String | The version component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
deleteArtifactVersion
findArtifactVersions
Find the most current artifact version that matches the given filters, along with its dependent artifact versions.
When invoked in the context of a job step, COMMANDER_JOBSTEPID will be automatically set as the jobStepId argument value unless jobStepId is already specified.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactKey | String | The artifactKey component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
artifactName | String | The name of the artifact containing the artifactVersion. |
artifactVersionName | String | The name of the artifactVersion to find. |
filters | filter array | Filters |
groupId | String | 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 | Boolean | Whether to include dependent artifact versions in results. |
jobStepId | String | If the retriever is a job-step, it gets registered as a consumer of the result artifactVersion. |
versionRange | String | Optional version range, specified in interval notation. |
getArtifactVersion
Find an artifact version by name.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactVersionName | String | The name of the artifactVersion. (Required) |
includeRetrieverJobSteps | Boolean | Whether to include retriever job-step info in the response. |
includeRetrieverJobs | Boolean | Whether to include retriever job info in the response. |
maxRetrievers | Integer | The maximum number of retriever jobs or jobsteps to return. |
getArtifactVersions
Retrieve all artifact versions in the system, possibly filtered by artifact, retriever job, or retriever job-step.
modifyArtifactVersion
Modifies an existing artifact version.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactVersionName | String | The name of the artifact version. |
artifactVersionState | String | The state of the artifact version. |
dependentArtifactVersions | String array | The set of artifactVersions on which this artifactVersion depends. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees Flow. |
newName | String | New name for an existing object that is being renamed. |
removeAllDependentArtifactVersions | Boolean | If true then all dependencies will be removed. |
repositoryName | String | The name of the artifact repository. |
removeDependentsFromArtifactVersion
Remove a list of dependent artifact versions from an existing artifact version.