Package io.blueocean.rest.pipeline.editor

Class ExportedDescribableParameter

java.lang.Object
io.blueocean.rest.pipeline.editor.ExportedDescribableParameter
@ExportedBean public class ExportedDescribableParameter extends Object
Exportable form of DescribableParameter

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.jenkinsci.plugins.structs.describable.DescribableParameter
    param
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExportedDescribableParameter(org.jenkinsci.plugins.structs.describable.DescribableParameter param)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCapitalizedName()
    Capitalized name of the parameter See DescribableParameter.getCapitalizedName()
    List<String>
    getCollectionTypes()
    Java types allowed if this is a collection See DescribableParameter.getType() and ParameterType.getActualType()
    String
    getDescriptorUrl()
     
    String
    getHelp()
    Help HTML (in English locale) for this parameter if available, else null See DescribableParameter.getHelp()
    boolean
    getIsDeprecated()
    Indicates this parameter is deprecated See DescribableParameter.isDeprecated()
    boolean
    getIsRequired()
    Indicates this parameter is required See DescribableParameter.isRequired()
    String
    getName()
    Name of the parameter See DescribableParameter.getName()
    String
    getType()
    Java class name for the parameter See DescribableParameter.getErasedType()

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • param

      protected final org.jenkinsci.plugins.structs.describable.DescribableParameter param

  • Constructor Details

    • ExportedDescribableParameter

      public ExportedDescribableParameter(org.jenkinsci.plugins.structs.describable.DescribableParameter param)

  • Method Details

    • getName

      @Exported public String getName()
      Name of the parameter See DescribableParameter.getName()

    • getIsRequired

      @Exported public boolean getIsRequired()
      Indicates this parameter is required See DescribableParameter.isRequired()

    • getType

      @Exported public String getType()
      Java class name for the parameter See DescribableParameter.getErasedType()

    • getCollectionTypes

      @Exported public List<String> getCollectionTypes()
      Java types allowed if this is a collection See DescribableParameter.getType() and ParameterType.getActualType()

    • getCapitalizedName

      @Exported public String getCapitalizedName()
      Capitalized name of the parameter See DescribableParameter.getCapitalizedName()

    • getIsDeprecated

      @Exported public boolean getIsDeprecated()
      Indicates this parameter is deprecated See DescribableParameter.isDeprecated()

    • getHelp

      @Exported public String getHelp() throws IOException
      Help HTML (in English locale) for this parameter if available, else null See DescribableParameter.getHelp()
      Throws:
      IOException

    • getDescriptorUrl

      @Exported public String getDescriptorUrl()