Pipeline: Input Step

input: Wait for interactive input

This step pauses Pipeline execution and allows the user to interact and control the flow of the build. Only a basic "process" or "abort" option is provided in the stage view.

You can optionally request information back, hence the name of the step. The parameter entry screen can be accessed via a link at the bottom of the build console log or via link in the sidebar for a build.

message

This parameter gives a prompt which will be shown to a human:

    Ready to go?
    Proceed or Abort
    

If you click "Proceed" the build will proceed to the next step, if you click "Abort" the build will be aborted.

Type: String

id (optional)

Every input step has an unique ID. It is used in the generated URL to proceed or abort.

A specific ID could be used, for example, to mechanically respond to the input from some external process/tool.

Type: String

ok (optional)

Type: String

parameters (optional)

Request that the submitter specify one or more parameter values when approving. If just one parameter is listed, its value will become the value of the input step. If multiple parameters are listed, the return value will be a map keyed by the parameter names. If parameters are not requested, the step returns nothing if approved.

On the parameter entry screen you are able to enter values for parameters that are defined in this field.

Array/List

Nested Choice of Objects $class: AppDetectorParamaterDefinition name:::

+ Type: String

appName

Type: String

description

Type: String

$class: AutoCompleteStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

displayExpression

Display is the text the user will see when inserting tokens. Use this field to control how the text will be shown to the user

  • When this field is empty, the value will be whole value
  • Specify the JSON field name
  • Write a javascript expression between {}'s and use the fields as if they were variables

If the data provider returns a simple list of strings, each value can be referred by the variable 'value' in javascript expressions

Some examples. Let's assume the data provider resulted in the following json:

[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]
Some valid examples:
  • name
  • house
  • {name}
  • {name+" ("+house+")"}

Type: String

valueExpression

Value is the text the job will receive in the parameter. Use this field to control how the text will provided to the job

  • When this field is empty, the value will be whole value (the whole json)
  • Specify the JSON field name to choose a specific field
  • Write a javascript expression between {}'s and use the fields as if they were variables

If the data provider returns a simple list of strings, each value can be referred by the variable 'value' in javascript expressions

Some examples. Let's assume the data provider resulted in the following json:

[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]
Some valid examples:
  • name
  • house
  • {name}
  • {name+" ("+house+")"}

Type: String

allowUnrecognizedTokens
If enabled, will allow the user to input tokens that are not in the data set.

Type: boolean

dataProvider
Choose a data provider to specify how to fetch the content to auto complete.

Nested Choice of Objects $class: GroovyDataProvider script::::

+

A groovy script that results in an array or collection of objects. It will work as long the elements in the result can be converted to JSON.

Type: String

sandbox

Type: boolean

classpath

Array/List

Nested Object

path:
A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.

Type: String

$class: InlineJsonDataProvider autoCompleteData::::

+

A json array of objects. For example:
[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]

Type: String

$class: RemoteDataProvider autoCompleteUrl::::

+

The remote end point. The endpoint response should be a json array of objects

Type: String

credentialsId
The credentials to access the endpoint, if needed.

Type: String

$class: SimpleTextProvider autoCompleteData::::

+

A list of values, one per line

Type: String

$class: BooleanParameterDefinition name:::

+ Type: String

defaultValue

Type: boolean

description

Type: String

$class: ChoiceParameterDefinition name:::

+ Type: String

choices

Type: String

description

Type: String

$class: ClearCaseUcmBaselineParameterDefinition

When used, this parameter will display a field at build-time so that the user is able to select the ClearCase UCM baseline from which to download the content to be worked with by this project.
To use this parameter, you MUST also set the SCM to be the ClearCase UCM baseline one, otherwise the build will fail.
The name of the selected ClearCase UCM baseline is available through the CLEARCASE_BASELINE environment variable.
pvob
Mandatory — Name of the ClearCase UCM PVOB.

Type: String

component
Mandatory — Name of the ClearCase UCM component which owns the ClearCase UCM baseline to download at build-time.
At build-time, the user will be able to select one of the ClearCase UCM baselines defined for this component.

Type: String

promotionLevel
Optional — Promotion level of the ClearCase UCM baseline to be downloaded at build-time.
If no promotion level is set (blank field), then the user will be presented with all the ClearCase UCM baselines belonging to the ClearCase UCM component defined above. If a promotion level is set, then, at build-time, the user will be presented with only the ClearCase UCM baselines which have been promoted to the specified level.

Type: String

stream
Optional — Stream of the ClearCase UCM baseline to be downloaded at build-time.
If no stream is set (blank field), then the user will be presented with all the ClearCase UCM baselines belonging to the ClearCase UCM component defined above. If a stream is set, then, at build-time, the user will be presented with only the ClearCase UCM baselines which have been defined on this stream.

Type: String

restrictions
Optional — List of folders (one folder per line) to be actually downloaded from ClearCase.
For this field to be taken into account, you need to check the Use snapshot view field.
If no restrictions are defined, then all the data for the selected ClearCase UCM baseline will be downloaded. If restrictions are defined, then only these folders will be downloaded.
For each folder to download, don't forget to prefix them with the VOB name and the component root dir (usually identical to the component name) this folder belongs to. For example, if you want to download the folder 05_impl/0_src which is in the fa4_web component of the fa4 VOB, set the value to /fa/fa4_web/05_impl/0_src.

Type: String

viewName
Mandatory — Name of the ClearCase UCM view which will be created to download the content of the baseline selected at build-time.
You can use several variables within the view name, such as:
  • CLEARCASE_BASELINE, which is replaced with the name of the ClearCase UCM baseline which is selected at build-time;
  • JOB_NAME, which is replaced with the name of the job;
  • USER_NAME, which is replaced with the name of the user running Hudson.
The ClearCase UCM view is available as two environment variables:
  • The name of the ClearCase UCM view is available as CLEARCASE_VIEWNAME;
  • The absolute path to the ClearCase UCM view is available as CLEARCASE_VIEWPATH.

Type: String

mkviewOptionalParam
Optional — If your build requires additional cleartool arguments when creating a view using mkview, specify them here.
Note that all other arguments (that is, -snapshot —if applicable— and -tag ${CLEARCASE_VIEWNAME} will be appended before these additional arguments.
For documentation on the mkview command, take a look at the ClearCase 7.0 Information Center.

Type: String

snapshotView

Type: boolean

useUpdate
Check this option to avoid recreating the Clearcase UCM view each time a build is triggered and the baseline has changed. Instead, the view config spec will be updated so that only files that have changed are loaded.

Type: boolean

forceRmview
Check this option to force the recreation of the ClearCase UCM view each time a build is triggered. If this option is not set and if the baseline which is selected when a new build is triggered is the same as for the previous build, then the ClearCase UCM view won't be recreated.
This setting can be overriden at run-time.

Type: boolean

excludeElementCheckedout
Check this option to exclude the element * CHECKEDOUT rule from the config spec.
Note that the element * CHECKEDOUT rule is mandatory when using snapshot views.

Type: boolean

moreRecentThan
Optional — Use this field to display, when triggering a new build, only the ClearCase UCM baselines which are more recent than a given number of years, or months, or weeks, or days.
Examples: 1 year, 6 months, 1 week, 10 days

Type: String

uuid

Type: String

$class: CredentialsParameterDefinition

Defines a credentials parameter, which you can use during a build.

For security reasons, the credential is NOT directly exposed, the UUID of the credential is exposed.

However, the selected credential is available through variable substitution in some other parts of the configuration. The string value will be the UUID of the credential. A supporting plugin can thus use the UUID to retrieve the selected credential and expose it to the build in an appropriate way.
name

Type: String

description

Type: String

defaultValue
The default credentials to use.

Type: String

credentialType

Type: String

required
When this option is selected, the credentials selection drop down will not provide the empty selection as one of the options. This will not prevent a build without a value if there are no credentials available, for example if the job does not have access to any credentials of the correct type or there is no default value and the user starting the build either does not have any credentials of the correct type in their personal credentials store or they do not have permissions on the job to use credentials from their personal store.

Type: boolean

$class: CvsTagsParamDefinition name:::

+

The name this parameter will be referred to as during any builds.

Type: String

cvsRoot

Type: String

passwordRequired

Type: boolean

password

Type: String

moduleName
The name of the item to retrieve a list of symbolic names for. This could be a module root (e.g. moduleName), subdirectory (e.g. moduleName/sub/directory/) or individual file (e.g. moduleName/sub/directory/file.name).

Type: String

$class: DateParameterDefinition name:::

+ Type: String

dateFormat
This is the Java date format. Like 'yyyyMMdd'.

Type: String

defaultValue
You can create a 'default value' in one of two forms.

1. Java LocalDate code style

  • LocalDate.now();
  • LocalDate.now().plusDays(1);
  • LocalDate.now().plusDays(1).plusYears(2);
  • LocalDate.now().minusDays(5).minusMonths(3).minusYears(2);

2. LocalDate String (This case should match the format of 'dateFormat')

  • 20170501
  • 2017-05-01

Type: String

description

Type: String

$class: DeployMetaDataParameterDefinition

A deployment meta data parameter allows you to specify environment and build version to deploy that will be used in "Collect deploy metadata" plugin.
name

Type: String

description

Type: String

environmentKey

Type: String

buildVersion

Type: String

applicationName

Type: String

$class: DropdownAutocompleteParameterDefinition name:::

+ Type: String

description

Type: String

displayExpression

Value is the text the job will receive in the parameter. Use this field to control how the text will provided to the job

  • When this field is empty, the value will be whole value (the whole json)
  • Specify the JSON field name to choose a specific field
  • Write a javascript expression between {}'s and use the fields as if they were variables

If the data provider returns a simple list of strings, each value can be referred by the variable 'value' in javascript expressions

Some examples. Let's assume the data provider resulted in the following json:

[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]
Some valid examples:
  • name
  • house
  • {name}
  • {name+" ("+house+")"}

Type: String

valueExpression

For data providers that returns JSON arrays, there are display and values. Display is the text the user will see when inserting tokens. Value is the value that will be given to the build.

This field allows you specify one the the json's field names, leave it empty to use the whole json as value or write a javascript expression using the fields between {}'s.

If the dataset returns a simple list of strings, the value of this field is ignored.

Some examples. Let's assume the dataset resulted in the following json:

[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]
Some valid examples:
  • name
  • house
  • {name}
  • {name+" ("+house+")"}

Type: String

defaultValue

Type: String

dataProvider

Nested Choice of Objects $class: GroovyDataProvider script::::

+

A groovy script that results in an array or collection of objects. It will work as long the elements in the result can be converted to JSON.

Type: String

sandbox

Type: boolean

classpath

Array/List

Nested Object

path:
A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.

Type: String

$class: InlineJsonDataProvider autoCompleteData::::

+

A json array of objects. For example:
[
	{"name": "Eddard Stark","id":"estark", "house":"Stark"},
	{"name": "John Snow","id":"jsnow", "house":"Stark"},
	{"name": "Tyrion Lannister","id":"tlannister", "house":"Lannister"},
	...
]

Type: String

$class: RemoteDataProvider autoCompleteUrl::::

+

The remote end point. The endpoint response should be a json array of objects

Type: String

credentialsId
The credentials to access the endpoint, if needed.

Type: String

$class: SimpleTextProvider autoCompleteData::::

+

A list of values, one per line

Type: String

$class: ExtensibleChoiceParameterDefinition name:::

+ Type: String

choiceListProvider
Select a provider that gives choices when build.

Nested Choice of Objects $class: ArtifactoryChoiceListProvider artifactId (optional)::::

+

Mandatory: The artifactId to search for in the repository.

Type: String

classifier (optional)
The Maven Artifact classifier, i.E. "sources". By default leave empty. You can specifiy a list of valid or invalid classifier separated by Comma, i.E. "sources,!jar"

Type: String

credentialsId (optional)
If your repository service requires user authentication, you'll have to configure the username and password here.

Type: String

groupId (optional)
Optional: The GroupId to search the artifact, i.E. "org.jenkins-ci.plugins"

Type: String

packaging (optional)
Optional: Filters the matching packaging type from the results, i.E. "jar" or "zip". Use a * to return all the values. If parameter is not set, only the parent folder is returned.

Type: String

reverseOrder (optional)
If the list should be returned in reverse order.

Type: boolean

url (optional)
Enter the URL of the Artifactory server, i.E. https://repo.jenkins-ci.org/

Type: String

$class: FilenameChoiceListProvider baseDirPath::::

+

Specify the path to the directory to scan for files. This path will not be contained in choice list strings. If specified as a relative path, it is considered as relative to ${JENKINS_HOME}.

Type: String

includePattern
Specify the pattern of files to list. Multiple patterns can be specified with separating with comma(,). Wildcard is available like '**/*.xml'. See includes attribute of Ant FileSet Type for the exact format.

Type: String

excludePattern
Specify patterns not to list (even specified in File Name Pattern field). See the help of "File Name Pattern" for the formats of patterns.

Type: String

scanType
Specify what type of files to list.

Values:

  • File

  • Directory

  • FileAndDirectory

    reverseOrder
    check to list files in reverse alphabetical order. If not checked, files are listed in alphabetical order.

Type: boolean

emptyChoiceType
Adds an empty choice to the specified place.

Values:

  • None

  • AtTop

  • AtEnd

$class: GlobalTextareaChoiceListProvider name::::

+

Select a name of the choice set, that you have specified in the system configuration.

Type: String

defaultChoice

Type: String

addEditedValue

Type: boolean

whenToAdd

Values:

  • Triggered

  • Completed

  • CompletedStable

  • CompletedUnstable

$class: MavenCentralChoiceListProvider artifactId (optional)::::

+

Mandatory: The artifactId to search for in the repository.

Type: String

classifier (optional)
The Maven Artifact classifier, i.E. "sources". By default leave empty. You can specifiy a list of valid or invalid classifier separated by Comma, i.E. "sources,!jar"

Type: String

groupId (optional)
Optional: The GroupId to search the artifact, i.E. "org.jenkins-ci.plugins"

Type: String

packaging (optional)
Optional: Filters the matching packaging type from the results, i.E. "jar" or "zip". Use a * to return all the values. If parameter is not set, only the parent folder is returned.

Type: String

reverseOrder (optional)
If the list should be returned in reverse order.

Type: boolean

$class: NexusChoiceListProvider artifactId (optional)::::

+

Mandatory: The artifactId to search for in the repository.

Type: String

classifier (optional)
The Maven Artifact classifier, i.E. "sources". By default leave empty. You can specifiy a list of valid or invalid classifier separated by Comma, i.E. "sources,!jar"

Type: String

credentialsId (optional)
If your repository service requires user authentication, you'll have to configure the username and password here.

Type: String

groupId (optional)
Optional: The GroupId to search the artifact, i.E. "org.jenkins-ci.plugins"

Type: String

packaging (optional)
Optional: Filters the matching packaging type from the results, i.E. "jar" or "zip". Use a * to return all the values. If parameter is not set, only the parent folder is returned.

Type: String

reverseOrder (optional)
If the list should be returned in reverse order.

Type: boolean

url (optional)
Enter the URL of the Nexus server, i.E. http://nexus.mycompany.com/nexus/

Type: String

$class: SystemGroovyChoiceListProvider groovyScript::::

+ Nested Object

script:

Type: String

sandbox:
If checked, run this Groovy script in a sandbox with limited abilities. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the script.

Type: boolean

classpath:
Additional classpath entries accessible from the script.

Array/List

Nested Object

path::
A path or URL to a JAR file. This path should be approved by an administrator or a user with the RUN_SCRIPT permission, or the script fails. If the file or files are once approved, they are treated approved even located in another path.

Type: String

defaultChoice

Type: String

usePredefinedVariables

Enable following pre-defined variables:

project
The project. An instance of Job.

Type: boolean

$class: TextareaChoiceListProvider choiceListText::::

+ Type: String

defaultChoice

Type: String

addEditedValue

Type: boolean

whenToAdd

Values:

  • Triggered

  • Completed

  • CompletedStable

  • CompletedUnstable

    editable
    With checked, you can specify a parameter other than those in the choice. Of course, you can also select a parameter from the choice.

Type: boolean

description

Type: String

$class: FileParameterDefinition name:::

+ Type: String

description

Type: String

$class: FileSystemListParameterDefinition

The filesystem-list-parameter-plugin lists file system object names of a directory. One of the object names can be selected as build parameter. In addition the objects can be filtered: ALL, DIRECTORY, FILE, SYMLINK. The order of the list can be reversed.
name
The name of the parameter.

Type: String

description
The type of the file system objects that will be filtered from path.

Type: String

path
The path of the directory containing the file system objects.

Type: String

selectedType
Objects in "Path" can be filtered: ALL, DIRECTORY, FILE, SYMLINK.

Type: String

regexIncludePattern
The regular expression matching the file system objects to be excluded in parameter selection. (Will be ignored if empty) See Standard Java regular expression.

Type: String

regexExcludePattern
The regular expression matching the file system objects to be included in parameter selection. (Will be ignored if empty) See Standard Java regular expression.

Type: String

sortByLastModified
If true, the list of the parameter values will be sorted by last modified file attribute. Default order is sort by parameter value.

Type: boolean

sortReverseOrder
If true, the list of the parameter values will be sorted in reverse order.

Type: boolean

$class: GeneratorChoiceParameterDefinition name:::

+ Type: String

choices

Type: String

description

Type: String

$class: GeneratorKeyValueParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: GitParameterDefinition

When used, this parameter will present a build-time a choice to select a Git tag (or revision number) which set a parameter for parametrized build.

Be aware that git does not allow us get additional information (like author/commmit date) from a remote URL this plugin will silently clone the project when your workspace is empty. This may take a long time when we have a slow connection and/or the checkout is big.

Often the parameter defined in the "Name" field is used to specify the branch of the git checkout.

name
The name of the parameter.

Type: String

type
The type of the list of parameters:
  • Tag - list of all commit tags in repository - returns Tag Name
  • Branch - list of all branch in repository - returns Branch Name
  • Revision - list of all revision sha1 in repository followed by its author and date - returns Tag SHA1

Type: String

defaultValue
This value is returned when list is empty.

Type: String

description
A description that will be shown to the user later.

Type: String

branch
Name of branch to look in. Used only if listing revisions.

Type: String

branchFilter
Regex used to filter displayed branches. If blank, the filter will default to ".*".
Remote branches will be listed with the remote name first. E.g., "origin/master"

Type: String

tagFilter
This parameter is used to get tag from git.
If is blank, parameter is set to "*".
Properly is executed command: git tag -l "*" or git tag -l "$tagFilter".

Type: String

sortMode
Wybór sposobu sortowania pobranych parametrów. Dotyczy tylko parametru typu gałąź, tag.
  • none
  • descending
  • ascending
  • ascending smart
  • descending smart
Przy wyborze inteligentnego (smart) sortowania sekwencje cyfr porównywane są jako liczby.

Values:

  • NONE

  • ASCENDING_SMART

  • DESCENDING_SMART

  • ASCENDING

  • DESCENDING

    selectedValue
    Which value is selected, after loaded parameters.
    If you choose 'default', but default value is not present on the list, nothing is selected.

Values:

  • NONE

  • TOP

  • DEFAULT

    useRepository
    If in the task is defined multiple repositories parameter specifies which the repository is taken into account.
    If the parameter is not defined, is taken first defined repository.
    The parameter is a regular expression which is compared with a URL repository.

Type: String

quickFilterEnabled
When this option is enabled will show a text field.
Parameter is filtered on the fly.

Type: boolean

$class: GithubBranchParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

githubRepoUrl

Type: String

$class: GlobalVariableStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: InheritableStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

inheritanceMode
This field selects, how this parameter is altered, when a child project overrides its value. For example, you may provide a variable "A" here with the value "Foo", while a child also defines "A", but with the value "Bar".

The mode that you select here will influence the final value of the parameter, when you build the child:

  • If you select "Overwritable", the build will just get the value "Bar"
  • If you select "Extensible", the build will get the value "FooBar" (or "Foo Bar", depending on the "Whitespace Mode" below)
  • If you select "Fixed", then the build will fail, since this project prohibited changing the value.
Do note, that this field only has an effect on the child parameter — not the other way around. In other words, this mode decides what will happen in the future, not what happens "now" to the current or earlier overrides.

Type: String

mustHaveDefaultValue

Type: boolean

mustBeAssigned

Type: boolean

whitespaceMode
This field allows you to select, how whitespaces at the start/end of the parameter should be handled, when a build is started:
  1. Trim all leading/trailing whitespace from the entered value.
  2. Keep the whitespace intact, exactly as the user entered it.
  3. Keep the whitespace, but make sure that at least a single space is added to the front of the value, in case it extends a parameter with the same name from a parent.
Select the first option, if you know the parameter should not have leading or trailing spaces.
Select the third option, if you are constructing a parameter that is used in flag- or command-construction. For example Compiler Flags.
Otherwise, or if in doubt, just select the second option.

Do note that, if trimming is selected, this has an effect on both the default value used for automatically started builds, as well as user-initiated builds where the user had a chance to alter the parameter value.

Type: String

isHidden
If this is checked, the parameter will be hidden behind an "advanced" button on the screen for starting a build. For sanity's sake, you should set this for all mandatory variables that are rarely changed.

Type: boolean

$class: InheritableStringParameterReferenceDefinition name:::

+ Type: String

defaultValue

Type: String

$class: JavaParameterDefinition

This parameter lets the user specify JDK to be used at the star of each build.
name
The name to be displayed on the build parameters page.

Type: String

description
The description to be shown on the build parameters page.

Type: String

defaultJDK
The JDK that will be used if the user does not specify one.

Type: String

allowedJDKs
The JDKs that can be chosen from on the build parameters page.

Array/List

Type: String

$class: JiraIssueParameterDefinition name:::

+ Type: String

description

Type: String

jiraIssueFilter
Specify the JQL search on JIRA instance. For a build, Jenkins will run this query, populate a drop-down list box, then ask the user to select one.

Type: String

$class: JiraVersionParameterDefinition name:::

+ Type: String

description

Type: String

jiraProjectKey

Specify the project key. A project key is the all capitals part before the issue number in JIRA.

(EXAMPLE-100)

Type: String

jiraReleasePattern

Specify a regular expression which release names have to match to be listed. Leave this blank to match all issues.

Example:

v[0-9]+([.][0-9]+)+ will match v1.0.1, v123, v12.0.1

Type: String

jiraShowReleased

Type: String

jiraShowArchived

Type: String

$class: LabelParameterDefinition name:::

+ Type: String

description

Type: String

defaultValue

Type: String

allNodesMatchingLabel

Type: boolean

nodeEligibility
Defines how selected offline nodes should be handled.
  • All Nodes - trigger the job on all selected nodes, regardless of there online/offline state
  • Ignore Offline Nodes - trigger the job only on nodes being online and having an executor
  • Ignore Temp Offline Nodes - trigger the job on all selected nodes except on the ones currently manually marked as offline

Nested Choice of Objects $class: AllNodeEligibility $class: IgnoreOfflineNodeEligibility $class: IgnoreTempOfflineNodeEligibility

triggerIfResult

Type: String

$class: ListSubversionTagsParameterDefinition

When used, this parameter will display a field at build-time so that the user is able to select a Subversion tag from which to create the working copy for this project.

Once the two fields Name and Repository URL are set, you must

  1. ensure the job uses Subversion and
  2. set the Repository URL field of Subversion by concatenating the two fields of this parameter.
For instance, if Name is set to SVN_TAG and Repository URL is set to https://svn.jenkins-ci.org/tags, then Subversion's Repository URL must be set to https://svn.jenkins-ci.org/tags/$SVN_TAG.

Notice that you can set the Repository URL field to a Subversion repository root rather than just pointing to a tags dir (ie, you can set it to https://svn.jenkins-ci.org rather than https://svn.jenkins-ci.org/tags). In that case, if this repository root contains the trunk, branches and tags folders, then the dropdown will allow the user to pick the trunk, or a branch, or a tag.

name

Type: String

tagsDir
Specify the Subversion repository URL which contains the tags to be listed when triggering a new build.

You can also specify the root of a Subversion repository: If this root contains the trunk, branches and tags folders, then the dropdown will display trunk, all the branches and all the tags. If the root does not contain these three folders, then all its subfolders are listed in the dropdown.

When you enter the URL, Jenkins automatically checks if it can connect to it. If access requires authentication, you'll be prompted for the necessary credential. If you already have a working credential but would like to change it for some other reasons, click this link and specify a different credential.

Type: String

credentialsId

Type: String

tagsFilter
Specify a regular expression which will be used to filter the tags which are actually displayed when triggering a new build.

Type: String

defaultValue
For features such as SVN polling a default value is required. If job will only be started manually, this field is not necessary.

Type: String

maxTags
The maximum number of tags to display in the dropdown. Any non-number value will default to all.

Type: String

reverseByDate
Check this option so that tags are sorted from the newest to the oldest.

If this option is checked, the Sort Z to A one won't be taken into account.

Type: boolean

reverseByName
Check this option so that tags are displayed in reverse order (sorted Z to A).

Notice that if Sort newest first is checked, this option won't be taken into account.

Type: boolean

$class: MatrixCombinationsParameterDefinition name:::

+ Type: String

description

Type: String

defaultCombinationFilter

A Groovy expression to specify which combinations are checked by default. They are also combinations which is built in a scheduled build. If not specified, the combination filter of this multi-configuration project is used. Also see help of the combination filter.

Note that you cannot enable combinations which disabled by the combination filter of the project.

Type: String

shortcutList
Links to check a set of combinations. Combinations to check are calculated with the last build in the build page or with the build to rebuild in the rebuild page (when Rebuild plugin is installed).

Array/List

Nested Choice of Objects $class: All

Check all enable combinations.

$class: CombinationFilterShortcut

Decide combinations to check with a combinations filter.
name
The name displayed as the shortcut link.

Type: String

combinationFilter
A Groovy expression to decide combinations to check.

Type: String

$class: None

Uncheck all combinations.

$class: PreviousShortcut

Check combinations built in the previous build.

$class: ResultShortcut

Check combinations with specific results in the previous build.
name
The name displayed as the shortcut link.

Type: String

exact
Only checks child builds running exactly in the previous build.

Type: boolean

resultsToCheck
Results of child builds to check.

Array/List

Type: String

$class: MavenMetadataParameterDefinition

This parameter allows the resolution of maven artifact versions by contacting the repository and reading the maven-metadata.xml.

If you named your parameter "MY_JAR" and have configured all values correctly. Then the following parameters will be set for the build step:
  • MY_JAR_VERSION - the version you selected in the dropdown or that was selected as part of an automated build
  • MY_JAR_ARTIFACT_URL - the full URL to the actual artifact selected. You can use something like "wget" to download that artifact and do something with it.
  • MY_JAR_GROUP_ID - echoes back your configuration
  • MY_JAR_ARTIFACT_ID - echoes back your configuration
  • MY_JAR_CLASSIFIER - echoes back your configuration
  • MY_JAR_PACKAGING - echoes back your configuration
name

Type: String

description

Type: String

repoBaseUrl

Type: String

groupId

Type: String

artifactId

Type: String

packaging

Type: String

classifier

Type: String

versionFilter
Specify a regular expression which will be used to filter the versions which are actually displayed when triggering a new build.

Type: String

sortOrder

Type: String

defaultValue
For features such as SVN polling a default value is required. If job will only be started manually, this field is not necessary.
There are 4 special default values which will be evaluated at runtime:
  • FIRST - will evaluate to the first item in the drop-down that would have been presented had the build been executed manually.
  • LAST - will evaluate to the last item in the drop-down that would have been presented had the build been executed manually.
  • RELEASE - will evaluate to the version marked as RELEASE in the repository metadata for the configured artifact. The versionFilter even if defined is ignored for this default value.
  • LATEST - will evaluate to the version marked as LATEST in the repository metadata for the configured artifact. The versionFilter even if defined is ignored for this default value.

Type: String

maxVersions
The maximum number of versions to display in the drop-down. Any non-number value as well as 0 or negative values will default to all.

Type: String

currentArtifactInfoUrl
The URL where an information resource about the currently used artifact can be requested. If the URL is provided and valid, the information will be displayed next to the drop-down. Otherwise not artifact information will be displayed.

Type: String

currentArtifactInfoLabel
An informational label that will be displayed in front of the aritfact information. When no label is specified, the default label Currently used artifact will be displayed. Any label will only be displayed when a valid Current Artifact Info URL is configured.

Type: String

currentArtifactInfoPattern
A pattern that describes the part of the artifact information resources' content to be displayed:
    When no pattern is specified, the whole content will be displayed.
    When a standard pattern is specified, only its first match in the content will be displayed.
    When a pattern with a capturing group is specified, only the first group of its first match in the content will be displayed.

Type: String

credentialsId

Type: String

$class: NodeParameterDefinition name:::

+ Type: String

description

Type: String

defaultSlaves

Array/List

Type: String

allowedSlaves

Array/List

Type: String

triggerIfResult

Type: String

nodeEligibility
Defines how selected offline nodes should be handled.
  • All Nodes - trigger the job on all selected nodes, regardless of there online/offline state
  • Ignore Offline Nodes - trigger the job only on nodes being online and having an executor
  • Ignore Temp Offline Nodes - trigger the job on all selected nodes except on the ones currently manually marked as offline

Nested Choice of Objects $class: AllNodeEligibility $class: IgnoreOfflineNodeEligibility $class: IgnoreTempOfflineNodeEligibility

$class: PackageChoiceParameterDefinition

List Content Packages available for download from a configured Adobe CRX repository.
name

Type: String

description

Type: String

baseUrl
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http:// deployer:Password123@localhost:4502

Type: String

credentialsId
Select the login credentials with which content packages will be listed from the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.

Type: String

requestTimeout
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.

Type: long

serviceTimeout
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.

Type: long

multiselect

Type: boolean

excludeNotInstalled
Filter the list to exclude packages which have been uploaded to the server, but which are not installed.

Type: boolean

excludeModified
Filter the list to exclude packages whose metadata have been modified after upload to the server, e.g. which need to be re-wrapped.

Type: boolean

visibleItemCount
Set the number of visible items displayed when multiselect is enabled. The default is 10.

Type: long

query
Specify a full-text search query to filter the list of packages, such as "Adobe".

Type: String

packageIdFilter
Specify a package ID filter to match against the list of packages returned from the configured Granite server.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':').

Package ID filters must follow one of three patterns:
  • group:name:version
  • group:name
  • name
Each segment in the filter may be either ommitted or replaced with an asterisk ('*') to represent a wildcard.

Type: String

value

Type: String

$class: PackageParameterDefinition name:::

+ Type: String

description

Type: String

rep

Type: String

pkg

Type: String

$class: ParameterSeparatorDefinition name:::

+ Type: String

separatorStyle

Type: String

sectionHeader

Type: String

sectionHeaderStyle

Type: String

$class: PatchParameterDefinition

Accepts a patch file to be submitted. This patch will be applied to the workspace after the source code is checked out, then the build will proceed.

$class: PersistentBooleanParameterDefinition name:::

+ Type: String

defaultValue

Type: boolean

successfulOnly

Type: boolean

description

Type: String

$class: PersistentChoiceParameterDefinition name:::

+ Type: String

choices

Type: String

successfulOnly

Type: boolean

description

Type: String

$class: PersistentPackageParameterDefinition name:::

+ Type: String

description

Type: String

useAwsKeys

If you need to access the repository outside of the repository, you will need grant access to the S3 bucket.

When accessing it from within AWS, it's probable that the server itself provides the necessary access rights.

When accessing it from outside, you need to provide a key pair. These are set up in the AWS admin console. If you don't have access, please ask operations to create a new key pair with access to the specified bucket.

Type: boolean

awsAccessKeyId

This is the AWS secret key setup in the AWS console. It will resemble the form: ‘AAAAAAAAAA2AAA2AAAAA

If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.

Type: String

awsSecretAccessKey

This is the AWS secret key setup in the AWS console. It will resemble the form: ‘XxXXXxx/1ZZz1zZZZ11zzZ1zz/YyYyYyyYyyyyYY

If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.

Type: String

bucketName

This should be set to a valid bucket name that you can access using the key value pair, or if within AWS, that the server has access to.

Ensure that the bucket specified contains the repo. It might sound obvious, but I just wanted to point that out.

Type: String

repoPath

This is the path to the actual repo containing the artifacts, relative to the AWS S3 bucket.

For example, given the S3 bucket ‘vhols-common-test-yumrepo’, the path to the locations-public-api repo is repos/locations-public-api

Type: String

repositoryType

Type: String

$class: PersistentStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

successfulOnly

Type: boolean

description

Type: String

$class: PersistentTextParameterDefinition name:::

+ Type: String

defaultValue

Type: String

successfulOnly

Type: boolean

description

Type: String

$class: PersistentYumParameterDefinition name:::

+ Type: String

description

Type: String

useAwsKeys

If you need to access the repository outside of the repository, you will need grant access to the S3 bucket.

When accessing it from within AWS, it's probable that the server itself provides the necessary access rights.

When accessing it from outside, you need to provide a key pair. These are set up in the AWS admin console. If you don't have access, please ask operations to create a new key pair with access to the specified bucket.

Type: boolean

awsAccessKeyId

This is the AWS secret key setup in the AWS console. It will resemble the form: ‘AAAAAAAAAA2AAA2AAAAA

If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.

Type: String

awsSecretAccessKey

This is the AWS secret key setup in the AWS console. It will resemble the form: ‘XxXXXxx/1ZZz1zZZZ11zzZ1zz/YyYyYyyYyyyyYY

If you don't have access to the AWS console, and you need an access key pair, please contact someone in operations.

Type: String

bucketName

This should be set to a valid bucket name that you can access using the key value pair, or if within AWS, that the server has access to.

Ensure that the bucket specified contains the repo. It might sound obvious, but I just wanted to point that out.

Type: String

repoPath

This is the path to the actual repo containing the artifacts, relative to the AWS S3 bucket.

For example, given the S3 bucket ‘vhols-common-test-yumrepo’, the path to the locations-public-api repo is repos/locations-public-api

Type: String

$class: PromotedBuildParameterDefinition name:::

+ Type: String

jobName

Type: String

process

Type: String

description

Type: String

$class: PromotionLevelParameter

Defines a parameter selected from the configured promotion levels. Note that the parameter provided to builds has the numeric value of the promotion level, i.e. its index in the list below, starting with one.
If used with the Copy Artifact plugin to copy artifacts of a particular promotion level, the name of the parameter should be COPY_PROMOTION_LEVEL.
name

Type: String

defaultLevel

Type: int

description

Type: String

$class: RandomStringParameterDefinition name:::

+ Type: String

failedValidationMessage

Type: String

description

Type: String

$class: ReviewboardParameterDefinition

Accepts a patch url or number of review request. This patch will be applied to the workspace after the source code is checked out, then the build will proceed.

$class: RunFilterParameter

Defines a parameter that can be used for a build filter of Copy Artifact.
name

Type: String

description

Type: String

defaultFilter

Nested Choice of Objects $class: AndRunFilter runFilterList::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter runFilterList:::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter::::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter::::

+ Nested Choice of Objects $class: AndRunFilter runFilterList:::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList:::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter runFilterList::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter runFilterList::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter runFilterList:::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter::::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::

+ Nested Choice of Objects $class: AndRunFilter runFilterList::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter:::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: RunParameterDefinition name:::

+ Type: String

projectName

Type: String

description

Type: String

filter

Values:

  • ALL

  • STABLE

  • SUCCESSFUL

  • COMPLETED

$class: RunSelectorParameter

Defines a parameter that specifies how a Copy Artifact build step should select which build to copy from. Note that this parameter type is easier to use when starting the build from a browser; to specify a value via direct HTTP POST or the CLI, valid XML must be given.

Be aware that this string value is encoded selector configuration, and not compatible with different plugin versions.

name

Type: String

defaultSelector

Nested Choice of Objects $class: BuildNumberRunSelector buildNumber::::

+

While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}").

Type: String

$class: FallbackRunSelector entryList::::

+ Array/List

Nested Object

runSelector:

Nested Choice of Objects $class: BuildNumberRunSelector buildNumber::::::

+

While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}").

Type: String

$class: FallbackRunSelector $class: ParameterizedRunSelector parameterName::::::

+

Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

Type: String

$class: PermalinkRunSelector id::::::

+ Type: String

$class: StatusRunSelector buildStatus::::::

+ Values:

  • STABLE

  • SUCCESSFUL

  • UNSTABLE

  • FAILED

  • COMPLETED

  • ANY

$class: TriggeringRunSelector allowUpstreamDependencies (optional)::::::

+

Tracks upstream builds not only with build-triggering relations, but also with relations via artifacts.

Type: boolean

upstreamFilterStrategy (optional)::
Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".

Values:

  • UseGlobalSetting

  • UseOldest

  • UseNewest

    runFilter:

    Nested Choice of Objects $class: AndRunFilter runFilterList::::::

    + Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter::::::

+ Nested Choice of Objects $class: AndRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter runFilterList::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::::

+ Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter runFilter:::::::

+ Nested Choice of Objects $class: AndRunFilter runFilterList:::::::

+ Array/List

Nested Choice of Objects $class: AndRunFilter $class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: DisplayNameRunFilter runDisplayName:::::::

+

Filter the run based on its display name. It accepts the first run that has the display name matching the given parameter. The iteration is done from newest to oldest run.

Type: String

$class: DownstreamRunFilter upstreamProjectName:::::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber:::
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: NotRunFilter $class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: OrRunFilter $class: ParameterizedRunFilter parameter:::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch:::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunFilter parameter::::::

+

Specify the value passed via the parameter "Build filter for Copy Artifact". E.g. You specified "Build filter for Copy Artifact" as PARAM, specify ${PARAM} here.

Type: String

$class: ParametersRunFilter paramsToMatch::::::

+

Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.

Type: String

$class: SavedRunFilter

$class: ParameterizedRunSelector parameterName::::

+

Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

Type: String

$class: PermalinkRunSelector id::::

+ Type: String

$class: StatusRunSelector buildStatus::::

+ Values:

  • STABLE

  • SUCCESSFUL

  • UNSTABLE

  • FAILED

  • COMPLETED

  • ANY

$class: TriggeringRunSelector allowUpstreamDependencies (optional)::::

+

Tracks upstream builds not only with build-triggering relations, but also with relations via artifacts.

Type: boolean

upstreamFilterStrategy (optional)
Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".

Values:

  • UseGlobalSetting

  • UseOldest

  • UseNewest

    description

    Type: String

$class: SauceParameterDefinition $class: ScriptSelectionTaskDefinition name:::

+ Type: String

path

Type: String

arrayCheckBox

Array/List

Nested Object

name

Type: String

variableName

Type: String

check

Type: boolean

type

Type: String

parent

Type: String

testDelimSymbol

Type: String

nodeDelimSymbol

Type: String

description

Type: String

countDelimiterSymbol

Type: int

delimiter

Type: String

defaultValue

Type: String

$class: SpringBootLibrariesListParameterDefinition springBootVersion:::

+ Type: String

$class: StashBranchParameterDefinition name:::

+

The name of the parameter.

Type: String

description

Type: String

repository

Type: String

defaultValue

Type: String

branchNameRegex (optional)

Type: String

tagNameRegex (optional)

Type: String

$class: StringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: TestExecuter

This plugin allows you to choose specific tests you want to run.
First, you need to specify the name of the environment variable in which you want your selected tests to be saved in (after build the selected tests will be in this environment variable as a JSON array).
Second, you need to enter the properties file path. This file will contain all your tests and maybe some extra fields for the plugin (more details about the properties file are in the appropriate help field).
After that, your tests will be shown in a tree diagram, allowing you to select some of them.
name
Enter the name of the environment variable in which you want your selected tests to be saved in (after build the selected tests will be in this environment variable as a JSON array).

Type: String

description

Type: String

propertiesFilePath
The properties file you enter must have a property called tests.
The tests property value is a JSON array that contains a JSON object for each test.
In each test object you need to specify it's attributes by a key/value pairs.

The following properties will allow you to select specific fields which have a special meaning:
1.   enableField - the name of the field that will imply if the test is enabled or not.
if the value in the specified field, for some test(s), will be false then the test will not be shown at all.
2.   groupBy - the field that the plugin will group the tests by.
if 2 tests have the same value in this field, they will be in the same group.
3.   showFields - the field(s) that will be shown in the tests tree.
4.   multiplicityField - the field that will be set to the amount of times the test should run.
5.   fieldSeparator - the character that will separate between the fields in the tests tree.
Each property must be defined either in the properties file or in the override section bellow.
If you want to change the properties you defined In the file, you can override them in the section bellow.

This is an example for a properties file which contains all above properties:
tests=[{"enabled":true,"owner":"shushu","testgroup":"A","testcase":"single"},{"enabled":false,"owner":"shushu","testgroup":"B","setuptype":"basic","testcase":"triple"}]
enableField=enabled
groupBy=testgroup
fieldSeparator=.
showFields=testsuite,testcase
multiplicityField=multiplicity

Type: String

enableField
Setting Enable Field property.
Enable Field - the name of the field that will imply if the test is enabled or not. If the value in the specified field, for some test(s), will be false then the test will not be shown at all.

Nested Object

text

Type: String

groupBy
Setting Group By property.
Group By - the field that the plugin will group the tests by. If 2 tests have the same value in this field, they will be in the same group.

Nested Object

text

Type: String

fieldSeparator
Setting Field Separator property.
Field Separator - the character that will separate between the fields in the tests tree.

Nested Object

text

Type: String

showFields
Setting Show Fields property.
Show Fields - the field(s) that will be shown in the tests tree.
If you click on "Show/Hide Available Fields" button then next to each available field appears (howManyTestsHasThisField/amountOfTests).

Nested Object

text

Type: String

multiplicityField
Setting Multiplicity Field property.
Multiplicity Field - the field that will be set to the amount of times the test should run.

Nested Object

text

Type: String

$class: TextParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: ToolVersionParameterDefinition toolName:::

+ Type: String

$class: VBoxParameterDefinition

Build parameter with virtual node names. Parameter name is exported to the build from virtual node names joined by node name delimiter.
name

Type: String

description

Type: String

nodeDelimiter

Type: String

$class: ValidatingStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

regex

Type: String

failedValidationMessage

Type: String

description

Type: String

$class: VersionParameterDefinition

Defines the artifact build parameter for selecting a version of this artifact.

  • Repository - the repository to resolve the artifact from
  • Group Id - the group id of the artifact to resolve
  • Artifact Id - the artifact id of the artifact to resolve
  • Description - a description for what the artifact is used for
This parameter type does not support a default value - therefore, this type should not be used in a scheduled job!
repoid

Type: String

groupid

Type: String

artifactid

Type: String

propertyName

Type: String

description

Type: String

$class: WHideParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: WReadonlyStringParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: WReadonlyTextParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: com.michelin.cio.hudson.plugins.passwordparam.PasswordParameterDefinition name:::

+ Type: String

description

Type: String

$class: com.moded.extendedchoiceparameter.ExtendedChoiceParameterDefinition name:::

+

The name of the parameter.

Type: String

type
The type of parameter:
  • Single Select: user chooses a single selection from a drop down menu, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)

  • Multi Select: a user can choose multiple selections from a multi-line box, populated by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)

  • Check Boxes: user can check off zero or more check boxes, labeled by either explicit values (see Value field below) or a property file (see Property File and Property Key fields below)

  • Multi-Level Single Select: user chooses a selection from a drop down, and then a another drop down appears with selections that depend on the first value, and upon second selection a third drop down may appear depending on the first two selections, and so on.

    The property file is a tab delimited file, with levels defined in columns and choices defined in rows. For example, to have a 2 level selection where you first select a country and then a city, you could specify a file such as the following:

    Country	City
    United States	San Francisco
    United States	Chicago
    Mexico	Mexico City
    Mexico	Cancun
                
    This would result in a first drop down with the options "Select a country...", "United States", and "Mexico" (the initial selection is "Select a country...", which serves as a label for the drop down). After the user selects a country, a "City" drop down would appear. If United States was chosen first, then San Francisco and Chicago would be options, but if Mexico was selected then instead Mexico City and Cancun would be options.

    The columns that should represent levels must be specified in the value field. For example "Country,City" could be valid values.

    Note that default values are not supported for multi-level selects.

  • Multi-Level Multi Select: same as single select, but after all levels are chosen, a button appears to "Select another..." and an additional multi-level selection is presented.

Type: String

value
Comma separated list of values for the single select or multi-select box.

This field can be left blank if the comma separated values need to be picked up from a properties file (set via 'Property File' and 'Property Key').

This value has different meaning for multi-level select -- see the parameter type help for more info.

Type: String

propertyFile
The properties file is a collection of key,value pairs of the form key=value1,value2,...

Property files may reference other properties. For example:
prop1=a,b,c,d,e
prop2=${prop1},f,g,h
The properties file can be placed anywhere on the file-system that Jenkins can access.

This property file has different meaning for multi-level select -- see the parameter type help for more info.

Type: String

propertyKey
The property of the property file to use.

For example, if the property file was the following:
prop1=a,b,c,d,e
prop2=1,2,3,4
Then you could specify the property as either prop1 or prop2.

Type: String

defaultValue
Initial selection of the single-select or mult-select box.

In case of the multi-select box, default value can be a comma separated string.

Type: String

defaultPropertyFile
Absolute path (specified without using environment variables).

Type: String

defaultPropertyKey

Type: String

quoteValue

Type: boolean

visibleItemCount

Type: int

description

Type: String

multiSelectDelimiter

Inserts this value between selections when the parameter is a multi-select.

The default when empty is ','

Type: String

bindFieldName

Type: String

svnPath

Type: boolean

svnUrl

Type: String

svnUserName

Type: String

svnPassword

Type: String

projectName

Type: String

roleBasedFilter

Type: boolean

$class: com.perfectomobile.jenkins.copyartifact.BuildSelectorParameter

Defines a parameter that specifies how a Copy Artifact build step should select which build to copy from. Note that this parameter type is easier to use when starting the build from a browser; to specify a value via direct HTTP POST or the CLI, valid XML must be given.
name

Type: String

defaultSelector

Nested Choice of Objects $class: ParameterizedBuildSelector parameterName::::

+ Type: String

$class: PermalinkBuildSelector id::::

+ Type: String

$class: SavedBuildSelector $class: SpecificBuildSelector buildNumber::::

+ Type: String

$class: StatusBuildSelector stableOnly::::

+ Type: boolean

$class: TriggeredBuildSelector fallback::::

+ Type: boolean

$class: WorkspaceSelector

description

Type: String

$class: com.veertu.plugin.anka.parameters.CloudSelectorParameter $class: hudson.model.PasswordParameterDefinition name:::

+ Type: String

defaultValue

Type: String

description

Type: String

$class: hudson.plugins.copyartifact.BuildSelectorParameter

Defines a parameter that specifies how a Copy Artifact build step should select which build to copy from. Note that this parameter type is easier to use when starting the build from a browser; to specify a value via direct HTTP POST or the CLI, valid XML must be given.

Be aware that this string value is encoded selector configuration, and not compatible with different plugin versions.

name

Type: String

defaultSelector

Nested Choice of Objects $class: DownstreamBuildSelector upstreamProjectName::::

+

Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.

Downstream builds are found using fingerprints of files. That is, a build that is triggerd from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.

Note: "Downsteram build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).

AbstractProject based projects:
Freestyle projects
Multi-configuration projects
Maven projects
Non AbstractProject based projects:
Pipeline jobs (aka. Workflow jobs)

Type: String

upstreamBuildNumber
The number of the build to find its downstream build. You can also specify display names. You can use variable expressions.

Type: String

$class: LastCompletedBuildSelector $class: MultiJobBuildSelector $class: ParameterizedBuildSelector parameterName::::

+

Name of the "build selector" parameter. A parameter with this name should be added in the build parameters section above. There is a special parameter type for choosing the build selector.

You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.

Type: String

$class: PermalinkBuildSelector id::::

+ Type: String

$class: PromotedBuildSelector level::::

+ Type: int

$class: SavedBuildSelector $class: SpecificBuildSelector buildNumber::::

+

While this selector is for build numbers (e.g. "22" for build #22), you can also resolve build parameters or environment variables (e.g. "${PARAM}"). The display name of a build and permalinks (e.g. "lastSuccessfulBuild", "lastBuild"...) can be used as well.

Type: String

$class: StatusBuildSelector stable::::

+ Type: boolean

$class: TriggeredBuildSelector fallbackToLastSuccessful::::

+ Type: boolean

upstreamFilterStrategy
Jenkins launches only one build when multiple upstreams triggered the same project at the same time. This field specifies from which upstream build to copy artifacts in those cases. "Use the oldest" copies artifacts from the upstream build with the smallest build number (that is, oldest). "Use the newest" copies artifacts from the upstream build with the largest build number (that is, newest). The default value is "Use global setting", which behaves as configured in "Manage Jenkins" > "Configure System".

Values:

  • UseGlobalSetting

  • UseOldest

  • UseNewest

    allowUpstreamDependencies

    Type: boolean

$class: WorkspaceSelector

description

Type: String

$class: org.jenkinsci.plugins.vsphere.parameters.CloudSelectorParameter

submitter (optional)
User IDs and/or external group names of person or people permitted to respond to the input, separated by ','. If you configure "alice, bob", will match with "alice" but not with "bob". You need to remove all the white spaces.

Type: String

submitterParameter (optional)
If specified, this is the name of the return value that will contain the ID of the user that approves this input. The return value will be handled in a fashion similar to the parameters value.

Type: String