addDependentsToArtifactVersion
Adds an artifact version query to an existing artifact. Dependent artifact versions are retrieved when the parent artifact version is retrieved.
cleanupArtifactCache
Deletes stale artifact versions from an artifact cache. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.
If you are not logged in as "admin", you cannot use this command. However, using the force option overrides admin login privileges. |
cleanupRepository
Deletes stale artifact versions from the repository backing-store. A "stale artifact version" is one whose metadata was previously deleted from the CloudBees CD/RO server.
If you are not logged in as "admin", you cannot use this command. However, using the force option overrides admin login privileges. |
Arguments
Argument Name | Type | Description |
---|---|---|
backingStoreDirectory |
String |
(Required) The repository directory where artifact versions are stored. |
force |
Boolean |
< Boolean flag— |
createArtifact
Creates a new artifact.
Arguments
Argument Name | Type | Description |
---|---|---|
groupId |
String |
(Required) The groupId component of the GAV (GroupId/ArtifactKey/Version) coordinates. |
artifactKey |
String |
(Required) The artifactKey component of the GAV (GroupId/ArtifactKey/Version) coordinates. |
artifactVersionNameTemplate |
String |
The artifactVersion name template. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
createArtifactVersion
Creates a new artifact version.
Arguments
Argument Name | Type | Description |
---|---|---|
version |
String |
(Required) The version component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
artifactKey |
String |
The artifactKey component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
artifactName |
String |
The name of the artifact containing the artifactVersion. |
dependentArtifactVersions |
Collection |
The set of artifactVersions on which this artifactVersion depends. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
groupId |
String |
The groupId component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
jobStepId |
UUID |
The ID of the job step; used to make a project association. |
repositoryName |
String |
The name of the artifact repository. |
createRepository
Creates a repository for one or more artifacts.
Arguments
Argument Name | Type | Description |
---|---|---|
repositoryName |
String |
(Required) The repository name. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
repositoryDisabled |
Boolean |
Whether or not to disable the repository. |
url |
String |
The url for contacting the repository. |
zoneName |
String |
The zone name. |
deleteArtifactVersion
deleteRepository
Deletes artifact repository metadata from the CloudBees CD/RO database. (This API call does not delete or remove artifacts stored on the repository machine.)
findArtifactVersions
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.
Because of the complexity of specifying filter criteria, this API is not supported by ectool. However, all of its capabilities are supported through the Perl API.
The retrieveArtifactVersions API uses this API to find the appropriate artifact version in the CloudBees CD/RO server and then retrieves the artifact version from a repository. You may prefer to use the retrieveArtifactVersions API instead of this API because while this API returns slightly different information, it also has the side-effect of retriever step registration mentioned above.
|
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 |
Collection |
A list of zero or more filter criteria definitions used to define objects to find. |
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 |
UUID |
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
Retrieves an artifact version by its name.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactVersionName |
String |
(Required) The name of the artifactVersion. |
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
Retrieves all artifact versions in the system, filtered by artifact name, retriever job ID, and/or retriever job step ID.
You must specify search filter criteria to find the artifact versions you need. If you do not provide any options, all artifact versions in the system are returned.
getManifest
Retrieves the manifest for a specified artifact version. The manifest includes a list of files and directories in the artifact version and its checksum file.
getRetrievedArtifacts
modifyArtifact
Modifies an existing artifact.
modifyArtifactVersion
Modifies an existing artifact version.
Arguments
Argument Name | Type | Description |
---|---|---|
artifactVersionName |
String |
(Required) The name of the artifact version. |
artifactVersionState |
ArtifactVersionState |
The state of the artifact version. |
dependentArtifactVersions |
Collection |
The set of artifactVersions on which this artifactVersion depends. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
String |
The 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. |
modifyRepository
Modifies an existing artifact repository.
Arguments
Argument Name | Type | Description |
---|---|---|
repositoryName |
String |
(Required) The repository name. |
description |
String |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
String |
The new name for an existing object that is being renamed. |
repositoryDisabled |
Boolean |
Whether or not to disable the repository. |
url |
String |
The url for contacting the repository. |
zoneName |
String |
The zone name. |
moveRepository
Moves an artifact repository in front of another, specified repository or to the end of the list. This API does not move artifact version data to another repository server machine. Only the repository order in which CloudBees CD/RO searches to retrieve an artifact version is changed.
Arguments
Argument Name | Type | Description |
---|---|---|
repositoryName |
String |
(Required) The repository name. |
beforeRepositoryName |
String |
Used when reordering the artifact repositories: the repository is moved to a position just before this repository. Blank means move the repository to the end of the artifact repository list. |
publishArtifactVersion
Publishes an artifact version to an artifact repository.
This API wraps the publish function in the ElectricCommander::ArtifactManagement Perl module and hides some additional functionality implemented in that module.
You must specify an artifactName or a groupId with an artifactKey.
|
Arguments
Argument Name | Type | Description |
---|---|---|
artifactName |
String |
The name of an artifact. |
artifactKey |
String |
User-specified identifier for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods. |
compress |
Boolean |
<Boolean flag— |
dependentArtifactVersions |
Collection |
One or more artifact version queries. The most current match of each query is retrieved when the primary artifact is retrieved. Dependent artifact version query strings are in this form: |
description |
String |
A plain text or HTML description for this object. If using HTML, you must surround your text with |
excludePatterns |
Collection |
Semicolon delimited list of file-path patterns indicating which files/directories under |
followSymlinks |
Boolean |
<Boolean flag— Default is "true". If true, follow symbolic links and record the target file contents with the symbolic link name in the artifact. If false, record the symbolic link as a symbolic link. Following symbolic links causes the publishing API to remain compatible with previous releases. |
fromDirectory |
String |
The directory containing files to publish as the artifact version. A subset of files can be published based on |
groupId |
String |
A user-generated group name for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods. |
includePatterns |
Collection |
Semicolon delimited list of file-path patterns indicating which files/directories under |
repositoryName |
String |
The name of the artifact repository where you want to publish. |
version |
String |
Unique identifier for the artifact version in the form: If a version argument is provided, but does not follow the above format, the version will be considered |
removeDependentsFromArtifactVersion
Removes a list of dependent artifact versions from an existing artifact version.
retrieveArtifactVersions
Retrieves the most recent artifact version, including its dependents, from an artifact repository.
This API wraps the retrieve function in the ElectricCommander::ArtifactManagement Perl module and hides some additional functionality implemented in that module.
You must specify search criteria options to locate the artifact versions you want to retrieve.
|
Arguments
Argument Name | Type | Description |
---|---|---|
artifactKey |
String |
User-specified identifier for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods. |
artifactName |
String |
The name of the artifact. |
artifactVersionName |
String |
The name of the artifact version. |
cacheDirectory |
String |
The directory where the artifact version is stored. The artifact version files are stored in a subdirectory under this cache directory. |
filters |
Collection |
A list of zero or more filter criteria definitions used to define objects to find. Each element of the filter list is a hash reference containing one filter criterion. You may specify several filter criteria, in which case an object must meet all filter criteria to be included in the result. There are two types of filters:
Each property filter consists of a property name to test and an operator to use for comparison. The property can be either an intrinsic property defined by CloudBees CD/RO or a custom property added by the user. Each operator takes zero, one, or two operands to compare against the desired property. Property filter operators are:
A Boolean filter is a Boolean operator and an array of one or more filters that are operands. Each operand can be either a property filter or a Boolean filter. Boolean operators are:
|
groupId |
String |
A user-generated group name for this artifact. This field may consist of alphanumeric characters, spaces, underscores, hyphens, and periods. |
includeDependents |
Boolean |
<Boolean flag— The default is
If the value is |
overwrite |
String |
Options are:
|
repositoryNames |
String |
A space-separated list of artifact repository names. Retrieval is attempted from each specified repository in a specified order until it succeeds or all specified repositories have rejected the retrieval. If not specified, and if this request is made in a job step context, a preferred list of repository names is obtained from the Resource definition in the server. If that list is empty, the global repository list is used. |
retryNumber |
Integer |
Number of retry attempts for the operation. The default is 1. The time between retry attempts is 20 seconds. |
toDirectory |
String |
Used to retrieve an artifact version to a specific directory without imposing the structure of a cache directory. Specify the full path to the new directory. If the artifact version is in a local cache directory. it will be copied out of the cache. If the artifact version is not in a cache directory, it will be downloaded directly to the specified directory, without putting it into a cache. |
versionRange |
String |
The range of versions to search. Version range syntax is standard number interval notation. Argument type: String |
updateArtifactVersion
Updates an artifact version by adding or replacing one or more files in the existing file and publishes the result as a new artifact version to an artifact repository.
This API wraps the update function in the ElectricCommander::ArtifactManagement Perl module and hides some additional functionality implemented in that module.
You must specify search criteria options to locate the artifact versions you want to update.
|
Arguments
Argument Name | Type | Description |
---|---|---|
artifactKey |
String |
User-specified identifier for this artifact. This field is limited to alphanumeric characters, spaces, underscores, hyphens, and periods. |
artifactName |
String |
The name of the artifact. |
description |
String |
A plain text or HTML description for this object. If using HTML, you must surround your text with |
excludePatterns |
Collection |
Semicolon delimited list of file-path patterns indicating which files/directories under |
followSymlinks |
Boolean |
<Boolean flag— |
fromDirectory |
String |
The directory containing files to publish as the artifact version. A subset of files can be published based on |
groupId |
String |
A user-generated group name for this artifact. This field is limited to alphanumeric characters, spaces, spaces, underscores, hyphens, and periods. |
includePatterns |
Collection |
Semicolon delimited list of file-path patterns indicating which files/directories under |
newVersion |
String |
Unique identifier for the new artifact version in the form: |
path |
String |
The path of the original artifact under which one or more files will be added or replaced. The default path is the root. |
version |
String |
Unique identifier for the artifact version in the form: |