FileSpec Tags

JFrog Pipelines Documentation

ft:sourceType
Paligo

name

An alphanumeric string (underscores are permitted) that identifies the resource.

type

Must be FileSpec for this resource type.

configuration

Specifies all configuration selections for the resource.

Tag

Description

Required/Optional

sourceArtifactory

The name of the Artifactory Integration.

Required

pattern

Specifies the source path in Artifactory, from which the artifacts should be downloaded, in the following format: [repository name]/[repository path]. You can use wildcards to specify multiple artifacts.

Required if aql is not specified

aql

An AQL query that specified the artifacts to be downloaded.

Note

  • AQL has to be in JSON format.

  • Ensure that there are no spaces in the AQL query.

  • The query does not support inputs such as limits and sorting. These are supported as inputs in filespec resource

Required if pattern is not specified

target

Specifies the local file system path to which artifacts should be downloaded.

For flexibility in specifying the target path, you can include placeholders in the form of {1}, {2}, {3}....These are replaced by corresponding tokens in the pattern property that are enclosed in parenthesis. For more information, see Using Placeholders.Using File Specs

Optional

props

List of "key=value" pairs separated by a semi-colon. (For example, "key1=value1;key2=value2;key3= value3"). Only artifacts with all the specified properties and values will be downloaded.

Optional

flat

[Default: false]

If true, artifacts are downloaded to the exact target path specified and their hierarchy in the source repository is ignored.

If false, artifacts are downloaded to the target path in the file system while maintaining their hierarchy in the source repository.

Optional

recursive

[Default: true]

If true, artifacts are also downloaded from sub-paths under the specified path in the source repository.

If false, only artifacts in the specified source path directory are downloaded.

Optional

excludePatterns

[Applicable only when 'pattern' is specified]

An array (enclosed with square brackets) of patterns to be excluded from downloading. Unlike the "pattern" property, "excludePatterns" must NOT include the repository as part of the pattern's path. You can use wildcards to specify multiple artifacts.

For example: ["*.sha1","*.md5"]

Optional

archiveEntries

If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts.

Optional

buildName

The name of the build to associate with this BuildInfo. Recommend using the environment variable available from the step that generated the build.

Optional

buildNumber

The number of the build to associate with this BuildInfo. Recommend using the environment variable available from the step that generated the build.

Optional

sortBy

A list of semicolon-separated fields to sort by. The fields must be part of the 'items' AQL domain. For more information read the AQL documentation.Artifactory Query Language

Optional

sortOrder

[Default: asc]

The order by which fields in the sortBy option should be sorted. Accepts asc or desc.

Optional

limit

The maximum number of items to fetch. Usually used with the sortBy option.

Optional

offset

The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the sortBy option.

Optional

For the remaining values, see the Artifactory topic Using File Specs.Using File Specs