Class WorkflowJob
- java.lang.Object
-
- hudson.model.AbstractModelObject
-
- hudson.model.Actionable
-
- hudson.model.AbstractItem
-
- hudson.model.Job<WorkflowJob,WorkflowRun>
-
- org.jenkinsci.plugins.workflow.job.WorkflowJob
-
- All Implemented Interfaces:
ExtensionPoint
,BuildableItem
,Describable<TopLevelItem>
,DescriptorByNameOwner
,Item
,ModelObject
,PersistenceRoot
,Queue.FlyweightTask
,SubTask
,Queue.Task
,ResourceActivity
,Saveable
,TopLevelItem
,SearchableModelObject
,SearchItem
,AccessControlled
,LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>
,ModelObjectWithChildren
,ModelObjectWithContextMenu
,ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
,SCMTriggerItem
,TriggeredItem
,OnMaster
,HasWidgets
,org.jenkinsci.plugins.workflow.flow.BlockableResume
,org.kohsuke.stapler.HttpDeletable
,org.kohsuke.stapler.StaplerOverridable
,org.kohsuke.stapler.StaplerProxy
public final class WorkflowJob extends Job<WorkflowJob,WorkflowRun> implements LazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>, ParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>, TopLevelItem, Queue.FlyweightTask, SCMTriggerItem, org.jenkinsci.plugins.workflow.flow.BlockableResume
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WorkflowJob.DescriptorImpl
static class
WorkflowJob.SCMListenerImpl
-
Nested classes/interfaces inherited from class hudson.model.Job
Job.LastItemListener, Job.SubItemBuildsLocationImpl
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Nested classes/interfaces inherited from interface jenkins.model.ModelObjectWithContextMenu
ModelObjectWithContextMenu.ContextMenu, ModelObjectWithContextMenu.ContextMenuVisibility, ModelObjectWithContextMenu.MenuItem, ModelObjectWithContextMenu.MenuItemType
-
Nested classes/interfaces inherited from interface jenkins.triggers.SCMTriggerItem
SCMTriggerItem.SCMTriggerItems
-
-
Field Summary
Fields Modifier and Type Field Description static Permission
ABORT
Deprecated.Just useItem.CANCEL
.-
Fields inherited from class hudson.model.Job
HISTORY_ADAPTER, nextBuildNumber, properties, runIdMigrator
-
Fields inherited from class hudson.model.AbstractItem
description, displayName, name, PRONOUN, SKIP_PERMISSION_CHECK, TASK_NOUN
-
-
Constructor Summary
Constructors Constructor Description WorkflowJob(ItemGroup parent, String name)
-
Method Summary
-
Methods inherited from class hudson.model.Job
assignBuildNumber, checkRename, delete, doBuildStatus, doChildrenContextMenu, doConfigSubmit, doDescription, doDoRename, doRssAll, doRssChangelog, doRssFailed, getAllJobs, getAllProperties, getBuildDir, getBuildDiscarder, getBuildForCLI, getBuildHealth, getBuildHealthReports, getBuilds, getBuilds, getBuildsAsMap, getBuildsByTimestamp, getBuildStatusIconClassName, getBuildStatusUrl, getBuildTimeGraph, getCharacteristicEnvVars, getDynamic, getEnvironment, getEstimatedDuration, getLastBuildsOverThreshold, getLastCompletedBuild, getLastFailedBuild, getLastStableBuild, getLastSuccessfulBuild, getLastUnstableBuild, getLastUnsuccessfulBuild, getLogRotator, getNewBuilds, getNextBuildNumber, getOverrides, getPermalinks, getProperties, getProperty, getProperty, getQueueItem, getTimeline, isBuilding, isHoldOffBuildUntilSave, isInQueue, isKeepDependencies, isLogUpdated, isNameEditable, logRotate, movedTo, onCopiedFrom, removeProperty, renameTo, save, saveNextBuildNumber, setBuildDiscarder, setLogRotator, supportsLogRotator, updateNextBuildNumber
-
Methods inherited from class hudson.model.AbstractItem
delete, doCheckNewName, doConfigDotXml, doConfirmRename, doDoDelete, doReload, doSetName, doSubmitDescription, getAbsoluteUrl, getApi, getConfigFile, getDescription, getDisplayName, getDisplayNameOrNull, getFullDisplayName, getFullName, getName, getParent, getRelativeDisplayNameFrom, getRelativeNameFromGroup, getRootDir, getSearchName, getSearchUrl, getShortUrl, getTarget, getTaskNoun, getUrl, resolveForCLI, setDescription, setDisplayName, setDisplayNameOrNull, toString, updateByXml, updateByXml, writeConfigDotXml, writeReplace
-
Methods inherited from class hudson.model.Actionable
addOrReplaceAction, doContextMenu, getAction, getAction, getActions, getActions, getAllActions, removeAction, removeActions, replaceActions
-
Methods inherited from class hudson.model.AbstractModelObject
getSearch, getSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface hudson.security.AccessControlled
checkAnyPermission, checkPermission, hasAnyPermission, hasPermission, hasPermission, hasPermission2
-
Methods inherited from interface hudson.model.BuildableItem
scheduleBuild, scheduleBuild
-
Methods inherited from interface hudson.model.DescriptorByNameOwner
getDescriptorByName
-
Methods inherited from interface jenkins.widgets.HasWidgets
getWidget, getWidgets
-
Methods inherited from interface hudson.model.Item
delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, save
-
Methods inherited from interface jenkins.model.ParameterizedJobMixIn.ParameterizedJob
createExecutable, doBuild, doBuildWithParameters, doCancelQueue, doDisable, doEnable, doPolling, getBuildNowText, getParameterizedJobMixIn, isParameterized, makeDisabled, scheduleBuild, scheduleBuild
-
Methods inherited from interface hudson.model.PersistenceRoot
getRootDir
-
Methods inherited from interface hudson.model.Queue.Task
getAffinityKey, getDefaultAuthentication, getDefaultAuthentication, getDefaultAuthentication2, getDefaultAuthentication2, getFullDisplayName, getName, getUrl, getWhyBlocked, isBuildBlocked
-
Methods inherited from interface hudson.model.ResourceActivity
getDisplayName, getResourceList
-
Methods inherited from interface jenkins.triggers.SCMTriggerItem
getNextBuildNumber, schedulePolling
-
Methods inherited from interface hudson.search.SearchableModelObject
getSearch
-
Methods inherited from interface hudson.search.SearchItem
getSearchIndex, getSearchName, getSearchUrl
-
Methods inherited from interface hudson.model.queue.SubTask
getEstimatedDuration, getOwnerExecutable, getOwnerTask
-
-
-
-
Field Detail
-
ABORT
@Deprecated public static final Permission ABORT
Deprecated.Just useItem.CANCEL
.
-
-
Method Detail
-
onCreatedFromScratch
public void onCreatedFromScratch()
- Specified by:
onCreatedFromScratch
in interfaceItem
- Overrides:
onCreatedFromScratch
in classJob<WorkflowJob,WorkflowRun>
-
onLoad
public void onLoad(ItemGroup<? extends Item> parent, String name) throws IOException
- Specified by:
onLoad
in interfaceItem
- Overrides:
onLoad
in classJob<WorkflowJob,WorkflowRun>
- Throws:
IOException
-
getDefinition
public org.jenkinsci.plugins.workflow.flow.FlowDefinition getDefinition()
-
setDefinition
public void setDefinition(org.jenkinsci.plugins.workflow.flow.FlowDefinition definition)
-
submit
protected void submit(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException, Descriptor.FormException
- Overrides:
submit
in classJob<WorkflowJob,WorkflowRun>
- Throws:
IOException
javax.servlet.ServletException
Descriptor.FormException
-
addProperty
public void addProperty(JobProperty jobProp) throws IOException
- Overrides:
addProperty
in classJob<WorkflowJob,WorkflowRun>
- Throws:
IOException
-
isBuildable
public boolean isBuildable()
- Specified by:
isBuildable
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
- Specified by:
isBuildable
in classJob<WorkflowJob,WorkflowRun>
-
_getRuns
protected RunMap<WorkflowRun> _getRuns()
- Specified by:
_getRuns
in classJob<WorkflowJob,WorkflowRun>
-
getLazyBuildMixIn
public LazyBuildMixIn<WorkflowJob,WorkflowRun> getLazyBuildMixIn()
- Specified by:
getLazyBuildMixIn
in interfaceLazyBuildMixIn.LazyLoadingJob<WorkflowJob,WorkflowRun>
-
removeRun
protected void removeRun(WorkflowRun run)
- Specified by:
removeRun
in classJob<WorkflowJob,WorkflowRun>
-
getBuild
@Deprecated public WorkflowRun getBuild(String id)
Deprecated.- Overrides:
getBuild
in classJob<WorkflowJob,WorkflowRun>
-
getBuildByNumber
public WorkflowRun getBuildByNumber(int n)
- Overrides:
getBuildByNumber
in classJob<WorkflowJob,WorkflowRun>
-
getFirstBuild
public WorkflowRun getFirstBuild()
- Overrides:
getFirstBuild
in classJob<WorkflowJob,WorkflowRun>
-
getLastBuild
public WorkflowRun getLastBuild()
- Overrides:
getLastBuild
in classJob<WorkflowJob,WorkflowRun>
-
getNearestBuild
public WorkflowRun getNearestBuild(int n)
- Overrides:
getNearestBuild
in classJob<WorkflowJob,WorkflowRun>
-
getNearestOldBuild
public WorkflowRun getNearestOldBuild(int n)
- Overrides:
getNearestOldBuild
in classJob<WorkflowJob,WorkflowRun>
-
getEstimatedDurationCandidates
protected List<WorkflowRun> getEstimatedDurationCandidates()
- Overrides:
getEstimatedDurationCandidates
in classJob<WorkflowJob,WorkflowRun>
-
createHistoryWidget
protected HistoryWidget createHistoryWidget()
- Overrides:
createHistoryWidget
in classJob<WorkflowJob,WorkflowRun>
-
scheduleBuild2
@CheckForNull public QueueTaskFuture<WorkflowRun> scheduleBuild2(int quietPeriod, Action... actions)
- Specified by:
scheduleBuild2
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
- Specified by:
scheduleBuild2
in interfaceSCMTriggerItem
-
makeSearchIndex
protected SearchIndexBuilder makeSearchIndex()
- Overrides:
makeSearchIndex
in classJob<WorkflowJob,WorkflowRun>
-
isDisabled
public boolean isDisabled()
- Specified by:
isDisabled
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
-
setDisabled
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public void setDisabled(boolean disabled)
- Specified by:
setDisabled
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
-
supportsMakeDisabled
public boolean supportsMakeDisabled()
- Specified by:
supportsMakeDisabled
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
-
getIconColor
public BallColor getIconColor()
- Overrides:
getIconColor
in classJob<WorkflowJob,WorkflowRun>
-
getAuthToken
public BuildAuthorizationToken getAuthToken()
- Specified by:
getAuthToken
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
-
getQuietPeriod
public int getQuietPeriod()
- Specified by:
getQuietPeriod
in interfaceParameterizedJobMixIn.ParameterizedJob<WorkflowJob,WorkflowRun>
- Specified by:
getQuietPeriod
in interfaceSCMTriggerItem
-
getHasCustomQuietPeriod
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public boolean getHasCustomQuietPeriod()
-
setQuietPeriod
public void setQuietPeriod(Integer seconds) throws IOException
- Throws:
IOException
-
getCauseOfBlockage
public CauseOfBlockage getCauseOfBlockage()
- Specified by:
getCauseOfBlockage
in interfaceQueue.Task
-
isConcurrentBuild
@Exported public boolean isConcurrentBuild()
- Specified by:
isConcurrentBuild
in interfaceQueue.Task
-
isResumeBlocked
@Exported public boolean isResumeBlocked()
- Specified by:
isResumeBlocked
in interfaceorg.jenkinsci.plugins.workflow.flow.BlockableResume
-
setResumeBlocked
public void setResumeBlocked(boolean resumeBlocked)
- Specified by:
setResumeBlocked
in interfaceorg.jenkinsci.plugins.workflow.flow.BlockableResume
-
setConcurrentBuild
public void setConcurrentBuild(boolean b) throws IOException
- Throws:
IOException
-
getACL
@NonNull public ACL getACL()
- Specified by:
getACL
in interfaceAccessControlled
- Overrides:
getACL
in classJob<WorkflowJob,WorkflowRun>
-
checkAbortPermission
public void checkAbortPermission()
- Specified by:
checkAbortPermission
in interfaceQueue.Task
-
hasAbortPermission
public boolean hasAbortPermission()
- Specified by:
hasAbortPermission
in interfaceQueue.Task
-
getSubTasks
public Collection<? extends SubTask> getSubTasks()
- Specified by:
getSubTasks
in interfaceQueue.Task
-
getAssignedLabel
public Label getAssignedLabel()
- Specified by:
getAssignedLabel
in interfaceSubTask
-
getLastBuiltOn
public Node getLastBuiltOn()
- Specified by:
getLastBuiltOn
in interfaceSubTask
-
getSameNodeConstraint
public Object getSameNodeConstraint()
- Specified by:
getSameNodeConstraint
in interfaceSubTask
-
getPronoun
public String getPronoun()
- Overrides:
getPronoun
in classJob<WorkflowJob,WorkflowRun>
-
getDescriptor
public TopLevelItemDescriptor getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<TopLevelItem>
- Specified by:
getDescriptor
in interfaceTopLevelItem
-
getTriggers
public Map<TriggerDescriptor,Trigger<?>> getTriggers()
- Specified by:
getTriggers
in interfaceTriggeredItem
-
getTriggersJobProperty
public PipelineTriggersJobProperty getTriggersJobProperty()
-
addTriggersJobPropertyWithoutStart
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public void addTriggersJobPropertyWithoutStart(PipelineTriggersJobProperty prop) throws IOException
- Throws:
IOException
-
setTriggers
public void setTriggers(List<Trigger<?>> inputTriggers) throws IOException
- Throws:
IOException
-
addTrigger
public void addTrigger(Trigger trigger) throws IOException
- Throws:
IOException
-
removeProperty
public void removeProperty(JobProperty jobProperty) throws IOException
- Overrides:
removeProperty
in classJob<WorkflowJob,WorkflowRun>
- Throws:
IOException
-
addAction
public void addAction(@NonNull Action a)
- Overrides:
addAction
in classActionable
-
replaceAction
public void replaceAction(@NonNull Action a)
- Overrides:
replaceAction
in classActionable
-
asItem
public Item asItem()
- Specified by:
asItem
in interfaceSCMTriggerItem
-
getSCMTrigger
public SCMTrigger getSCMTrigger()
- Specified by:
getSCMTrigger
in interfaceSCMTriggerItem
-
getSCMs
@NonNull public Collection<? extends SCM> getSCMs()
- Specified by:
getSCMs
in interfaceSCMTriggerItem
-
getTypicalSCM
@CheckForNull public SCM getTypicalSCM()
-
poll
@NonNull public PollingResult poll(@NonNull TaskListener listener)
- Specified by:
poll
in interfaceSCMTriggerItem
-
performDelete
protected void performDelete() throws IOException, InterruptedException
- Overrides:
performDelete
in classAbstractItem
- Throws:
IOException
InterruptedException
-
alias
@Initializer(before=EXTENSIONS_AUGMENTED) public static void alias()
-
-