pyjen.plugins.paramtrigger_buildtrigger module

Trigger configuration for a parameterized build trigger

class pyjen.plugins.paramtrigger_buildtrigger.BuildTriggerConfig(node)[source]

Bases: pyjen.utils.xml_plugin.XMLPlugin

Contains the configuration options for a single downstream build trigger compatible with the parameterized build trigger plugin

https://plugins.jenkins.io/parameterized-trigger

Parameters: node (xml.etree.ElementTree.Element) – XML node with the decoded XML data associated with a plugin

add_build_param(param_config)[source]

Adds a new configuration option for customizing the build parameters passed to the jobs that are triggered by this configuration

Parameters: param_config (XMLPlugin) – One of several supported plugins which offer unique customizations on how build parameters for the downstream jobs being triggered

property build_params

List of parameter definitions used to configure the build trigger for the downstream jobs associated with this trigger

Each element in the list may be of any number of derived types, each supporting a different type of custom behavior on how the parameters for the downstream job should be created / set.

Type: list (XMLPlugin)

property condition

The state the current job must be in before the downstream job will be triggered

Type: str

static get_jenkins_plugin_name()[source]

str: the name of the Jenkins plugin associated with this PyJen plugin

This static method is used by the PyJen plugin API to associate this class with a specific Jenkins plugin, as it is encoded in the config.xml

classmethod instantiate(job_names)[source]

Factory method for creating a new instances of this class

Parameters: job_names (list of str) – List of the names of 1 or more Jenkins jobs to be triggered by this configuration object
Returns: instance of this class
Return type: BuildTriggerConfig

property job_names

list of the names of downstream jobs to be triggered

Type: list (str)

pyjen.plugins.paramtrigger_buildtrigger.PluginClass: alias of pyjen.plugins.paramtrigger_buildtrigger.BuildTriggerConfig