Jenkins Tutorials: Meaning of $class in scripted pipeline

Posted by

In Jenkins pipeline scripts, the $class parameter is used to specify the class or type of an object. The complete list of $class values depends on the specific plugins and extensions installed in your Jenkins instance. Each plugin or extension may introduce its own set of classes that can be used in the pipeline script.

However, here are some common $class values that are frequently used in Jenkins pipeline scripts:

  • 'ChoiceParameter': Represents a parameter with a choice or selection.
  • 'CascadeChoiceParameter': Represents a parameter with cascading choices or selections.
  • 'GroovyScript': Represents a script block containing Groovy code.
  • 'StringParameterDefinition': Represents a parameter for accepting a string value.
  • 'BooleanParameterDefinition': Represents a parameter for accepting a boolean value.
  • 'RunParameterDefinition': Represents a parameter for selecting a specific Jenkins run or build.
  • 'FileParameterDefinition': Represents a parameter for accepting a file as input.
  • 'TextParameterDefinition': Represents a parameter for accepting multiline text as input.
  • 'PasswordParameterDefinition': Represents a parameter for accepting a password or sensitive information.

These are just a few examples, and the available $class values can vary depending on the plugins and extensions installed in your Jenkins environment. It’s recommended to refer to the documentation of the specific plugins you are using to determine the supported $class values and their configurations.

Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x