pyjen.plugins.parambuild_string module

String build parameter - plugin for parameterized build plugin

class pyjen.plugins.parambuild_string.ParameterizedBuildStringParameter(node)[source]

Bases: pyjen.utils.xml_plugin.XMLPlugin

String build parameter - plugin for parameterized build plugin

Parameters

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

property default_value

the default value for this parameter

Type

str

property description

the descriptive text associated with this parameter

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(name, default_value, description, trim)[source]

Factory method for creating a new string build parameter

Parameters

  • name (str) – Friendly name to give this build parameter

  • default_value (str) – Text to assign this parameter when no user defined value is given

  • description (str) – Descriptive text to show on the Jenkins UI explaining the purpose of this parameter

  • trim (bool) – Indicates whether leading and trailing whitespace should be stripped from values entered into this field at build time

Returns

instance of this class

Return type

ParameterizedBuildStringParameter

property name

Gets the friendly name assigned to this parameter

Return type

str

property trim

Checks to see if the value for this parameter should have whitespace stripped from the start and end automatically

Type

bool

pyjen.plugins.parambuild_string.PluginClass

alias of pyjen.plugins.parambuild_string.ParameterizedBuildStringParameter