Package hudson.model

Class RunParameterValue

java.lang.Object
hudson.model.ParameterValue
hudson.model.RunParameterValue
All Implemented Interfaces:
Serializable

public class RunParameterValue extends ParameterValue
See Also:
  • Constructor Details

    • RunParameterValue

      @DataBoundConstructor public RunParameterValue(String name, String runId, String description)
    • RunParameterValue

      public RunParameterValue(String name, String runId)
  • Method Details

    • getRun

      @CheckForNull public Run getRun()
      Can be null if the Run that this was pointing to no longer exists.
    • getRunId

      public String getRunId()
    • getJobName

      @Exported public String getJobName()
    • getNumber

      @Exported public String getNumber()
    • getValue

      public Run getValue()
      Description copied from class: ParameterValue
      Returns the most natural Java object that represents the actual value, like boolean, string, etc.
      Overrides:
      getValue in class ParameterValue
      Returns:
      if there is no natural value for this parameter type, this may be used; null may be used when the value is normally defined but missing in this case for various reasons
    • buildEnvironment

      public void buildEnvironment(Run<?,?> build, EnvVars env)
      Exposes the name/value as an environment variable.
      Overrides:
      buildEnvironment in class ParameterValue
      Parameters:
      build - The build for which this parameter is being used. Never null.
      env - never null.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getShortDescription

      public String getShortDescription()
      Description copied from class: ParameterValue
      Computes a human-readable possible-localized one-line description of the parameter value.

      This message is used as a tooltip to describe jobs in the queue. The text should be one line without new line. No HTML allowed (the caller will perform necessary HTML escapes, so any text can be returned.)

      Overrides:
      getShortDescription in class ParameterValue