io.blueocean.rest.pipeline.editor

Class ExportedPipelineStep

java.lang.Object

io.blueocean.rest.pipeline.editor.ExportedDescribableModel

io.blueocean.rest.pipeline.editor.ExportedPipelineFunction

io.blueocean.rest.pipeline.editor.ExportedPipelineStep

@ExportedBean
public class ExportedPipelineStep
extends ExportedPipelineFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected org.jenkinsci.plugins.workflow.steps.StepDescriptor	descriptor

Fields inherited from class io.blueocean.rest.pipeline.editor.ExportedPipelineFunction

functionName

Fields inherited from class io.blueocean.rest.pipeline.editor.ExportedDescribableModel

model, symbol

Constructor Summary

Constructors

Constructor and Description
ExportedPipelineStep(org.jenkinsci.plugins.structs.describable.DescribableModel<? extends org.jenkinsci.plugins.workflow.steps.Step> model, String functionName, org.jenkinsci.plugins.workflow.steps.StepDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
String	getDescriptorUrl() Relative descriptor URL for this step
boolean	getIsBlockContainer() Indicates this step wraps a block of other steps
List<String>	getProvidedContext() The Java class names that this pipeline step exports into context
List<String>	getRequiredContext() The Java class names that this pipeline requires to be in context

Methods inherited from class io.blueocean.rest.pipeline.editor.ExportedPipelineFunction

getFunctionName

Methods inherited from class io.blueocean.rest.pipeline.editor.ExportedDescribableModel

getDisplayName, getHasSingleRequiredParameter, getHelp, getParameters, getSymbol, getType

Methods inherited from class java.lang.Object

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

Field Detail

descriptor

protected final org.jenkinsci.plugins.workflow.steps.StepDescriptor descriptor

Constructor Detail

ExportedPipelineStep

public ExportedPipelineStep(org.jenkinsci.plugins.structs.describable.DescribableModel<? extends org.jenkinsci.plugins.workflow.steps.Step> model,
                            String functionName,
                            org.jenkinsci.plugins.workflow.steps.StepDescriptor descriptor)

Method Detail

getProvidedContext

@Exported
public List<String> getProvidedContext()

The Java class names that this pipeline step exports into context

getRequiredContext

@Exported
public List<String> getRequiredContext()

The Java class names that this pipeline requires to be in context

getIsBlockContainer

@Exported
public boolean getIsBlockContainer()

Indicates this step wraps a block of other steps

Overrides:

getIsBlockContainer in class ExportedPipelineFunction

getDescriptorUrl

@Exported
public String getDescriptorUrl()

Relative descriptor URL for this step