Class ExportedDescribableModel
- java.lang.Object
-
- io.blueocean.rest.pipeline.editor.ExportedDescribableModel
-
- Direct Known Subclasses:
ExportedPipelineFunction
@ExportedBean public class ExportedDescribableModel extends Object
-
-
Constructor Summary
Constructors Constructor Description ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model)
ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model, String symbol)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName()
Display Name of the describable class SeeDescribableModel.getDisplayName()
boolean
getHasSingleRequiredParameter()
Whether this describable has one and only one parameter and it is required.String
getHelp()
Loads help defined for this object as a whole if available, else null.List<ExportedDescribableParameter>
getParameters()
Properties the describable supports SeeDescribableModel.getParameters()
String
getSymbol()
Provides the symbol for this describableString
getType()
The Java class name for this describable (since we can't seem to export a Class<?> ...) SeeDescribableModel.getType()
-
-
-
Field Detail
-
model
protected final org.jenkinsci.plugins.structs.describable.DescribableModel<?> model
-
symbol
protected final String symbol
-
-
Constructor Detail
-
ExportedDescribableModel
public ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model)
-
ExportedDescribableModel
public ExportedDescribableModel(org.jenkinsci.plugins.structs.describable.DescribableModel<?> model, String symbol)
-
-
Method Detail
-
getType
@Exported public String getType()
The Java class name for this describable (since we can't seem to export a Class<?> ...) SeeDescribableModel.getType()
-
getSymbol
@Exported public String getSymbol()
Provides the symbol for this describable- Returns:
-
getDisplayName
@Exported public String getDisplayName()
Display Name of the describable class SeeDescribableModel.getDisplayName()
-
getHasSingleRequiredParameter
@Exported public boolean getHasSingleRequiredParameter()
Whether this describable has one and only one parameter and it is required. SeeDescribableModel.hasSingleRequiredParameter()
-
getHelp
@Exported public String getHelp() throws IOException
Loads help defined for this object as a whole if available, else null. SeeDescribableModel.getHelp()
- Throws:
IOException
-
getParameters
@Exported public List<ExportedDescribableParameter> getParameters()
Properties the describable supports SeeDescribableModel.getParameters()
-
-