pyjen.plugins.buildblocker module

Interfaces for interacting with Build Blockers job property plugin

class pyjen.plugins.buildblocker.BuildBlockerProperty(node)

Bases: pyjen.utils.xml_plugin.XMLPlugin

Wrapper for Build Blocker job properties

https://wiki.jenkins-ci.org/display/JENKINS/Build+Blocker+Plugin

Parameters

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

LEVEL_TYPES = ('GLOBAL', 'NODE')

QUEUE_SCAN_TYPES = ('DISABLED', 'ALL', 'BUILDABLE')

property blockers

list of search criteria for blocking jobs

Type

list (str)

disable()

Disables this set of build blockers

enable()

Enables this set of build blockers

static get_jenkins_plugin_name()

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(patterns)

Factory method used to instantiate an instance of this plugin

Parameters

patterns (list, str) – One or more names or regular expressions for jobs that block the execution of this one.

Returns

reference to the newly instantiated object

Return type

BuildBlockerProperty

property is_enabled

True if these blocking jobs are enabled, False if not

Type

bool

property level

the scope of the blocked job settings. One of BuildBlockerProperty.LEVEL_TYPES

Type

str

property queue_scan

checks to see whether build blocking scans the build queue or not. One of BuildBlockerProperty.QUEUE_SCAN_TYPES.

Type

str

pyjen.plugins.buildblocker.PluginClass

alias of pyjen.plugins.buildblocker.BuildBlockerProperty