A B C D E F G H I J L M N O P Q R S T U V W _ 
All Classes All Packages

A

AbstractFlowScanner - Class in org.jenkinsci.plugins.workflow.graphanalysis
Core APIs and base logic for FlowScanners that extract information from a pipeline execution.
AbstractFlowScanner() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
addHead(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
 
addHeads(List<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
 
addListener(GraphListener) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Add a listener to changes in the flow graph structure.
addTag(String, String) - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Add a tag key:value pair to this FlowNode, null or empty values are ignored Inputs are CheckForNull so you can directly pass in values without nullchecks upfront.
all() - Static method in class org.jenkinsci.plugins.workflow.pickles.PickleFactory
 
all() - Static method in class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor
 
allNodes(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Convenience method to get the list all flownodes in the iterator order.
allNodes(FlowExecution) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Convenience method to get the list of all FlowNodes for the execution, in iterator order.
apply(Function<StepExecution, Void>) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList.StepExecutionIteratorImpl
 
apply(TaskListener, FlowExecutionOwner, TaskListenerDecorator) - Static method in class org.jenkinsci.plugins.workflow.log.TaskListenerDecorator
Wraps a logger in a supplied decorator as well as any available from TaskListenerDecorator.Factorys.
apply(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepNamePredicate
 
apply(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepTypePredicate
 
ArgumentsAction - Class in org.jenkinsci.plugins.workflow.actions
Stores some or all of the arguments used to create and configure the Step executed by a FlowNode.
ArgumentsAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
 
ArgumentsAction.NotStoredReason - Enum in org.jenkinsci.plugins.workflow.actions
Used as a placeholder marker for Step arguments not stored for various reasons.
asFlowExecutionOwner() - Method in interface org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner.Executable
Gets the associated owner moniker.
atomNode(FlowNode, FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Called for a flownode neither start nor end.
atomNode(FlowNode, FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
Extend me to do something with nodes inside a chunk
AtomNode - Class in org.jenkinsci.plugins.workflow.graph
FlowNode that has no further FlowNodes inside.
AtomNode(FlowExecution, String, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.AtomNode
 

B

BlockableResume - Interface in org.jenkinsci.plugins.workflow.flow
Can be added to advertise the ability to mark pipeline components which prevent pipelines from being able to resume after restart or after pause.
BlockChunkFinder - Class in org.jenkinsci.plugins.workflow.graphanalysis
Matches start and end of a block.
BlockChunkFinder() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.BlockChunkFinder
 
BlockEndNode<START extends BlockStartNode> - Class in org.jenkinsci.plugins.workflow.graph
End of a block.
BlockEndNode(FlowExecution, String, START, List<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graph.BlockEndNode
 
BlockEndNode(FlowExecution, String, START, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.BlockEndNode
 
blocksRestart() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Determines whether the activity currently being run should block a Jenkins restart.
BlockStartNode - Class in org.jenkinsci.plugins.workflow.graph
Together with BlockEndNode, designates some kind of nested structure that contains "children", which are FlowNodes that are in between BlockStartNode and BlockEndNode
BlockStartNode(FlowExecution, String, List<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graph.BlockStartNode
 
BlockStartNode(FlowExecution, String, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.BlockStartNode
 
BodyInvocationAction - Class in org.jenkinsci.plugins.workflow.actions
Attached to BlockStartNode to indicate that this block represents an invocation of body block.
BodyInvocationAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.BodyInvocationAction
 
BrokenLogStorage - Class in org.jenkinsci.plugins.workflow.log
Placeholder for storage broken by some kind of access error.
BrokenLogStorage(Throwable) - Constructor for class org.jenkinsci.plugins.workflow.log.BrokenLogStorage
 
ByRun() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowCopier.ByRun
 

C

CANCELLED - org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
The Queue.Item has left the queue but no WorkspaceAction is present on the FlowNode.
chunk - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
chunkEnd(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Called when hitting the end of a chunk.
chunkEnd(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
ChunkFinder - Interface in org.jenkinsci.plugins.workflow.graphanalysis
Think of this as setting conditions to mark a region of interest in the graph of FlowNode from a FlowExecution.
chunkStart(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Called when hitting the start of a chunk.
chunkStart(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
clearAll(Run<?, ?>) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
clearAll(Run<?, ?>, TaskListener) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Delete any and all stashes in a build.
clearAllStashes(TaskListener) - Method in interface org.jenkinsci.plugins.workflow.flow.StashManager.StashAwareArtifactManager
 
clearCache() - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
configure(StaplerRequest, JSONObject) - Method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
ConsoleAnnotators - Class in org.jenkinsci.plugins.workflow.log
Some utility code extracted from AnnotatedLargeText which probably belongs in ConsoleAnnotator or ConsoleAnnotationOutputStream.
convertToFastCheckable(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Helper: convert stop nodes to a collection that can efficiently be checked for membership, handling null if needed
copy(Run<?, ?>, Run<?, ?>, TaskListener) - Method in class org.jenkinsci.plugins.workflow.flow.FlowCopier.ByRun
Copies metadata between builds.
copy(Run<?, ?>, Run<?, ?>, TaskListener) - Method in class org.jenkinsci.plugins.workflow.flow.FlowCopier.StandardActions
 
copy(Run<?, ?>, Run<?, ?>, TaskListener) - Method in class org.jenkinsci.plugins.workflow.flow.StashManager.CopyStashesAndArtifacts
 
copy(FlowExecutionOwner, FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.flow.FlowCopier.ByRun
 
copy(FlowExecutionOwner, FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.flow.FlowCopier
Copies any required metadata or files from one to another.
copyAll(Run<?, ?>, Run<?, ?>) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
without replacement; only used from StashManager.CopyStashesAndArtifacts anyway
copyAllArtifactsAndStashes(Run<?, ?>, TaskListener) - Method in interface org.jenkinsci.plugins.workflow.flow.StashManager.StashAwareArtifactManager
Copy all stashes and artifacts from one build to another.
CopyStashesAndArtifacts() - Constructor for class org.jenkinsci.plugins.workflow.flow.StashManager.CopyStashesAndArtifacts
 
create(FlowExecutionOwner, TaskListener, List<? extends Action>) - Method in class org.jenkinsci.plugins.workflow.flow.FlowDefinition
Starts a brand new execution of this definition from the beginning.
create(FlowExecutionOwner, List<? extends Action>) - Method in class org.jenkinsci.plugins.workflow.flow.FlowDefinition
Deprecated.
createAnnotator(T) - Static method in class org.jenkinsci.plugins.workflow.log.ConsoleAnnotators

D

decorate(OutputStream) - Method in class org.jenkinsci.plugins.workflow.log.TaskListenerDecorator
Apply modifications to a build log.
DepthFirstScanner - Class in org.jenkinsci.plugins.workflow.graphanalysis
Does a simple and somewhat efficient depth-first search of all FlowNodes in the DAG.
DepthFirstScanner() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
DescriptorImpl() - Constructor for class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
directExecutor() - Static method in class org.jenkinsci.plugins.workflow.flow.MoreExecutors
Returns an Executor that runs each task in the thread that invokes execute, as in ThreadPoolExecutor.CallerRunsPolicy.
dummyOwner() - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
A placeholder implementation for use in compatibility stubs.
durabilityHint - Variable in class org.jenkinsci.plugins.workflow.flow.FlowExecution
CheckForNull due to loading pre-durability runs.
DurabilityHintProvider - Interface in org.jenkinsci.plugins.workflow.flow
Provides a way to indirectly register durability settings to apply to pipelines.

E

EnclosingBlocksIterable(GraphLookupView, FlowNode) - Constructor for class org.jenkinsci.plugins.workflow.graph.GraphLookupView.EnclosingBlocksIterable
 
endStep() - Static method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Closes an HTML step block.
equals(Object) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
FlowExecutionOwners are equal to one another if and only if they point to the same FlowExecution object.
equals(Object) - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
ErrorAction - Class in org.jenkinsci.plugins.workflow.actions
Attached to FlowNode that caused an error.
ErrorAction(Throwable) - Constructor for class org.jenkinsci.plugins.workflow.actions.ErrorAction
 

F

fetchEnclosingBlocks(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.FlowScanningUtils
Deprecated.
FileLogStorage - Class in org.jenkinsci.plugins.workflow.log
Simple implementation of log storage in a single file that maintains a side file with an index indicating where node transitions occur.
FilePathUtils - Class in org.jenkinsci.plugins.workflow
Candidates for inclusion in FilePath.
FilePathUtils.Listener - Class in org.jenkinsci.plugins.workflow
 
filter(Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Expose a filtered view of this FlowScanner's output.
filter(Predicate<T>) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.Filterator
Returns a filtered view of the iterator, which calls the iterator until matches are found
Filterator<T> - Interface in org.jenkinsci.plugins.workflow.graphanalysis
Iterator that may be navigated through a filtered wrapper.
filteredNodes(Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
filteredNodes(Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
filteredNodes(Collection<FlowNode>, Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Return a filtered list of FlowNodes matching a condition, in the order encountered.
filteredNodes(Collection<FlowNode>, Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Return a filtered list of FlowNodes matching a condition, in the order encountered.
filteredNodes(FlowExecution, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
filteredNodes(FlowNode, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Syntactic sugar for AbstractFlowScanner.filteredNodes(Collection, Collection, Predicate) with a single head and no denyList nodes
find(String, String) - Static method in class org.jenkinsci.plugins.workflow.FilePathUtils
Attempts to create a live file handle based on persistable data.
findAllEnclosingBlockStarts(FlowNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
findAllEnclosingBlockStarts(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graph.GraphLookupView
Return all enclosing block start nodes, as with GraphLookupView.findEnclosingBlockStart(FlowNode).
findAllEnclosingBlockStarts(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
findEnclosingBlockStart(FlowNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
findEnclosingBlockStart(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graph.GraphLookupView
Find the immediately enclosing BlockStartNode around a FlowNode
findEnclosingBlockStart(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
findFirstMatch(Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Syntactic sugar for AbstractFlowScanner.findFirstMatch(Collection, Collection, Predicate) where there is no denyList
findFirstMatch(Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
findFirstMatch(Collection<FlowNode>, Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Find the first FlowNode within the iteration order matching a given condition Includes null-checking on arguments to allow directly calling with unchecked inputs (simplifies use).
findFirstMatch(Collection<FlowNode>, Collection<FlowNode>, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Find the first FlowNode within the iteration order matching a given condition Includes null-checking on arguments to allow directly calling with unchecked inputs (simplifies use).
findFirstMatch(FlowExecution, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
findFirstMatch(FlowExecution, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Deprecated.
unsafe to call
findFirstMatch(FlowNode, Predicate<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Syntactic sugar for AbstractFlowScanner.findFirstMatch(Collection, Collection, Predicate) where there is a single head and no denyList
fireCompleted(FlowExecution) - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
fireCreated(FlowExecution) - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
fireResumed(FlowExecution) - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
fireRunning(FlowExecution) - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
firstNode - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
FlowActionStorage - Interface in org.jenkinsci.plugins.workflow.graph
Abstraction for persisting Actions for FlowNode, which is the only mutable part of FlowNodes.
FlowChunk - Interface in org.jenkinsci.plugins.workflow.graphanalysis
Common container interface for a series of FlowNodes with a logical start and end.
FlowChunkWithContext - Interface in org.jenkinsci.plugins.workflow.graphanalysis
FlowChunk with information about what comes before/after
FlowCopier - Class in org.jenkinsci.plugins.workflow.flow
A way for plugins to copy metadata and associated files from one flow execution to another.
FlowCopier() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowCopier
 
FlowCopier.ByRun - Class in org.jenkinsci.plugins.workflow.flow
Convenience implementation that only operates on true builds.
FlowCopier.StandardActions - Class in org.jenkinsci.plugins.workflow.flow
 
FlowDefinition - Class in org.jenkinsci.plugins.workflow.flow
Actual executable script.
FlowDefinition() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowDefinition
 
FlowDefinitionDescriptor - Class in org.jenkinsci.plugins.workflow.flow
 
FlowDefinitionDescriptor() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowDefinitionDescriptor
 
FlowDurabilityHint - Enum in org.jenkinsci.plugins.workflow.flow
Provides hints about just how hard we should try to protect our workflow from failures of the controller.
FlowDurabilityHint_MAX_SURVIVABILITY_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.MAX_SURVIVABILITY.description: Maximum durability but slowest (previously the only option).
FlowDurabilityHint_MAX_SURVIVABILITY_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.MAX_SURVIVABILITY.tooltip: Writes data with every step, using atomic writes for integrity. Provides maximum ability to retain running pipeline data and resume in the event of a Jenkins failure..
FlowDurabilityHint_PERFORMANCE_OPTIMIZED_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.PERFORMANCE_OPTIMIZED.description: Performance-optimized: much faster (requires clean shutdown to save running pipelines).
FlowDurabilityHint_PERFORMANCE_OPTIMIZED_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.PERFORMANCE_OPTIMIZED.tooltip: Avoids writing data with every step, avoids atomic writes of data. Pipelines can resume if Jenkins shuts down cleanly, but running pipelines lose step information and cannot resume if Jenkins unexpectedly fails..
FlowDurabilityHint_SURVIVABLE_NONATOMIC_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.SURVIVABLE_NONATOMIC.description: Less durability, a bit faster (specialty use only).
FlowDurabilityHint_SURVIVABLE_NONATOMIC_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.SURVIVABLE_NONATOMIC.tooltip: Writes data with every step but avoids atomic writes. On some filesytems this is faster than maximum durability mode, but running pipeline data may be lost if disk writes are interrupted or fail..
FlowEndNode - Class in org.jenkinsci.plugins.workflow.graph
End of the entire program.
FlowEndNode(FlowExecution, String, FlowStartNode, Result, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowEndNode
 
FlowExecution - Class in org.jenkinsci.plugins.workflow.flow
State of a currently executing workflow.
FlowExecution() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
FlowExecutionList - Class in org.jenkinsci.plugins.workflow.flow
Tracks the running FlowExecutions so that it can be enumerated.
FlowExecutionList() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
 
FlowExecutionList.ItemListenerImpl - Class in org.jenkinsci.plugins.workflow.flow
When Jenkins starts up and everything is loaded, be sure to proactively resurrect all the ongoing FlowExecutions so that they start running again.
FlowExecutionList.StepExecutionIteratorImpl - Class in org.jenkinsci.plugins.workflow.flow
Enumerates StepExecutions running inside FlowExecution.
FlowExecutionListener - Class in org.jenkinsci.plugins.workflow.flow
Listens for significant status updates for a FlowExecution, such as started running or completed.
FlowExecutionListener() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
 
FlowExecutionOwner - Class in org.jenkinsci.plugins.workflow.flow
We need something that's serializable in small moniker that helps us find THE instance of FlowExecution.
FlowExecutionOwner() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
 
FlowExecutionOwner.Executable - Interface in org.jenkinsci.plugins.workflow.flow
Marker interface for queue executables from FlowExecutionOwner.getExecutable().
FlowGraphWalker - Class in org.jenkinsci.plugins.workflow.graph
Visits a graph of flow nodes and iterates nodes in them.
FlowGraphWalker() - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
 
FlowGraphWalker(FlowExecution) - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
 
FlowNode - Class in org.jenkinsci.plugins.workflow.graph
One node in a flow graph.
FlowNode(FlowExecution, String, List<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowNode
 
FlowNode(FlowExecution, String, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowNode
 
FlowNodeAction - Interface in org.jenkinsci.plugins.workflow.actions
Action that gets a reference to FlowNode back when it gets deserialized.
FlowNodeViewColumn - Class in org.jenkinsci.plugins.workflow.visualization.table
Extension point for adding a column to a table rendering of FlowNodes.
FlowNodeViewColumn() - Constructor for class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn
 
FlowNodeViewColumnDescriptor - Class in org.jenkinsci.plugins.workflow.visualization.table
FlowNodeViewColumnDescriptor() - Constructor for class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor
 
FlowNodeViewColumnDescriptor(Class<? extends FlowNodeViewColumn>) - Constructor for class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor
 
FlowNodeVisitor - Interface in org.jenkinsci.plugins.workflow.graphanalysis
Interface used when examining a pipeline FlowNode graph node by node, and terminating when a condition is met
FlowScanningUtils - Class in org.jenkinsci.plugins.workflow.graphanalysis
Library of common functionality when analyzing/walking flow graphs
FlowStartNode - Class in org.jenkinsci.plugins.workflow.graph
Start of the entire flow.
FlowStartNode(FlowExecution, String) - Constructor for class org.jenkinsci.plugins.workflow.graph.FlowStartNode
 
forBuild(FlowExecutionOwner) - Method in interface org.jenkinsci.plugins.workflow.log.LogStorageFactory
Checks whether we should handle a given build.
forFile(File) - Static method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
 
ForkNode - Class in org.jenkinsci.plugins.workflow.graph
Deprecated.
unused
ForkNode(FlowExecution, String, FlowNode...) - Constructor for class org.jenkinsci.plugins.workflow.graph.ForkNode
Deprecated.
 
ForkScanner - Class in org.jenkinsci.plugins.workflow.graphanalysis
Scanner that will scan down all forks when we hit parallel blocks before continuing, but generally runs in linear order
ForkScanner() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
ForkScanner(Collection<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
ForkScanner(Collection<FlowNode>, Collection<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
fromConsoleLogFilter(ConsoleLogFilter) - Static method in class org.jenkinsci.plugins.workflow.log.TaskListenerDecorator
Tries to translate a similar core interface into the new API.

G

get() - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
 
get() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
 
getAction(Class<T>) - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getActions() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getAllEnclosingIds() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Returns a read-only view of the IDs for enclosing blocks of this flow node, innermost first.
getArguments() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get the map of arguments used to instantiate the Step, with a ArgumentsAction.NotStoredReason instead of the argument value supplied in the executed pipeline step if that value is filtered for size or security.
getArguments(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get the map of arguments supplied to instantiate the Step run in the FlowNode given or empty if the arguments were not stored or the FlowNode was not a step.
getArgumentsInternal() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Return a fast view of internal arguments, without creating immutable wrappers
getArgumentValue(String) - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get the value of a argument, or null if not present/not stored.
getArgumentValueOrReason(String) - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get the argument value or its ArgumentsAction.NotStoredReason if it has been intentionally omitted.
getAuthentication() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Looks up authentication associated with this flow execution.
getBranches() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.ParallelFlowChunk
Returns the branches of a parallel flow chunk, mapped by branch name and parallel branch block
getBranches() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ParallelMemoryFlowChunk
 
getCauseOfFailure() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
If this execution has completed with an error, report that.
getColumnCaption() - Method in class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn
Returns the name of the column that explains what this column means
getCurrentExecutions() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Deprecated.
getCurrentExecutions(boolean) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Yields the StepExecutions that are currently executing.
getCurrentHeads() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
In the current flow graph, return all the "head" nodes where the graph is still growing.
getCurrentParallelStartNode() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
Return the node that begins the current parallel head, if we are known to be in a parallel block
getCurrentType() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
getDefaultDurabilityHint() - Static method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel
 
getDefaultInstance() - Method in class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor
Deprecated.
Don't use this method outside the core workflow plugins as we'll likely change this.
getDefaultInstances() - Static method in class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumnDescriptor
Deprecated.
Don't use this method outside the core workflow plugins as we'll likely change this.
getDescription() - Method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
 
getDescriptor() - Method in class org.jenkinsci.plugins.workflow.flow.FlowDefinition
 
getDescriptor() - Method in interface org.jenkinsci.plugins.workflow.graph.StepNode
Returns the descriptor for Step that produced this flow node.
getDescriptor() - Method in class org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn
 
getDescriptorId() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepNamePredicate
 
getDisplayFunctionName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.ErrorAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.LabelAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.LogAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.TimingAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
getDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getDurabilityHint() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Get the durability level we're aiming for, or a default value if none is set (defaults may change as implementation evolve).
getDurabilityHint() - Method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
getDurabilityHintValues() - Static method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
getEnclosingBlocks() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Get the list of enclosing BlockStartNodes, starting from innermost, for this node.
getEnclosingId() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Get the FlowNode.id of the enclosing BlockStartNodefor this node, or null if none.
getEndNode() - Method in class org.jenkinsci.plugins.workflow.graph.BlockStartNode
Return the BlockEndNode for this block, or null if the block hasn't completed yet.
getEndNode(BlockStartNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
getEndNode(BlockStartNode) - Method in interface org.jenkinsci.plugins.workflow.graph.GraphLookupView
Find the end node corresponding to a start node, and can be used to tell if the block is completed.
getEndNode(BlockStartNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
getError() - Method in class org.jenkinsci.plugins.workflow.actions.ErrorAction
 
getError() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
If this node has terminated with an error, return an object that indicates that.
getExecutable() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
The executor slot running this flow, such as a Run.
getExecution() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getFilteredArguments() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get just the fully stored, non-null arguments This means the arguments with all ArgumentsAction.NotStoredReason or null values removed
getFilteredArguments(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Get just the fully stored, non-null arguments This means the arguments with all ArgumentsAction.NotStoredReason or null values removed
getFirstNode() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.FlowChunk
 
getFirstNode() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
getIconColor() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Returns colored orb that represents the current state of this node.
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.ErrorAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.LabelAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.LogAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.TimingAction
 
getIconFileName() - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
getId() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Has to be unique within a FlowExecution.
getInternalGraphLookup() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Eventually this may be overridden if the FlowExecution has a better source of structural information, such as the FlowNode storage.
getLabels() - Method in class org.jenkinsci.plugins.workflow.actions.WorkspaceAction
The Node.getAssignedLabels() of the node owning the workspace.
getLastNode() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.FlowChunk
 
getLastNode() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
getListener() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
Gets a listener to which we may print general messages.
getLogFile(FlowExecutionOwner.Executable, boolean) - Method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
Deprecated.
getLogFile(FlowExecutionOwner.Executable, boolean) - Method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Deprecated.
Only used for compatibility with Run.getLogFile().
getLogText() - Method in class org.jenkinsci.plugins.workflow.actions.LogAction
Access the log file and expose it to the UI with the progressive logging functionality
getMessage() - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
getName() - Method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
For compatibility with Jelly, etc.
getNextType() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
getNode() - Method in class org.jenkinsci.plugins.workflow.actions.WorkspaceAction
The Node.getNodeName() of the workspace.
getNode(String) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Loads a node by its ID.
getNodeAfter() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.FlowChunkWithContext
Return the node after this chunk, or null if it is the end
getNodeAfter() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
getNodeBefore() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.FlowChunkWithContext
Return the node before this chunk, or null if it is the beginning
getNodeBefore() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
getNodeName(FilePath) - Static method in class org.jenkinsci.plugins.workflow.FilePathUtils
Same as FilePathUtils.getNodeNameOrNull(hudson.FilePath) but throws a diagnostic exception in case of failure.
getNodeNameOrNull(FilePath) - Static method in class org.jenkinsci.plugins.workflow.FilePathUtils
Looks up the Node.getNodeName() corresponding to a given file.
getNodeState(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.QueueItemAction
Get the current QueueItemAction.QueueState for a FlowNode.
getOrNull() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
Same as FlowExecutionOwner.get() but avoids throwing an exception or blocking.
getOwner() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
getParallelDepth() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
Return number of levels deep we are in parallel blocks
getParentIds() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
getParents() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Returns a read-only view of parents.
getParents() - Method in class org.jenkinsci.plugins.workflow.graph.FlowStartNode
Deprecated.
Why are you calling a method that always return empty list?
getPath() - Method in class org.jenkinsci.plugins.workflow.actions.WorkspaceAction
The FilePath.getRemote() of the workspace.
getPauseTimeMillis() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
getPersistentAction(Class<T>) - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Return the first nontransient Action on the FlowNode, without consulting TransientActionFactorys
getQueueItem(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.QueueItemAction
 
getRequiredGlobalConfigPagePermission() - Method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
getResolvedArguments(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Like ArgumentsAction.getArguments(FlowNode) but attempting to resolve actual classes.
getResult() - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
getResult() - Method in class org.jenkinsci.plugins.workflow.graph.FlowEndNode
 
getRootDir() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
A directory (on the controller) where information may be persisted.
getSCMs() - Method in class org.jenkinsci.plugins.workflow.flow.FlowDefinition
Returns a list of all SCMs that are part of the static configuration of the FlowDefinition.
getSearchUrl() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Reference from the parent SearchItem is through FlowExecution.getNode(String)
getStageName() - Method in interface org.jenkinsci.plugins.workflow.actions.StageAction
Gets the name of the stage.
getStartNode() - Method in class org.jenkinsci.plugins.workflow.graph.BlockEndNode
Returns the matching start node.
getStartTime() - Method in class org.jenkinsci.plugins.workflow.actions.TimingAction
 
getStartTime(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.TimingAction
 
getStepArgumentsAsString(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Return a tidy string description for the step arguments, or null if none is present or we can't make one See StepDescriptor.argumentsToString(Map) for the rules
getStepDescriptor() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepTypePredicate
 
getSuggestedDurabilityHint() - Static method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
getTags() - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Get the tag-value mappings
getTags(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Get the set of tag-value mappings for a node
getTagValue(String) - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Get the value for a tag, null if not set Input is CheckForNull so you can directly pass in values without nullchecks upfront.
getTagValue(FlowNode, String) - Static method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Get the value for a tag on a flownode, null if not set (convenience) Input is CheckForNull so you can directly pass in values without nullchecks upfront.
getThreadName() - Method in interface org.jenkinsci.plugins.workflow.actions.ThreadNameAction
 
getTooltip() - Method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
 
getTypeDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowEndNode
 
getTypeDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Gets a human readable name for this type of the node.
getTypeDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowStartNode
 
getTypeDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.ForkNode
Deprecated.
 
getTypeDisplayName() - Method in class org.jenkinsci.plugins.workflow.graph.JoinNode
Deprecated.
 
getTypeFunctionName() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Gets a human readable text that may include a StepDescriptor.getFunctionName().
getUrl() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Returns the URL of this FlowExecution, relative to the context root of Jenkins.
getUrl() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
Returns the URL of the model object that owns FlowExecution, relative to the context root of Jenkins.
getUrl() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Returns the URL of this FlowNode, relative to the context root of Jenkins.
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.ErrorAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.LabelAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.LogAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.TimingAction
 
getUrlName() - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
getUrlOfExecution() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
 
getWorkspace() - Method in class org.jenkinsci.plugins.workflow.actions.WorkspaceAction
Reconstructs the live workspace, if possible.
GlobalDefaultFlowDurabilityLevel - Class in org.jenkinsci.plugins.workflow.flow
Supports a global default durability level for users
GlobalDefaultFlowDurabilityLevel() - Constructor for class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel
 
GlobalDefaultFlowDurabilityLevel.DescriptorImpl - Class in org.jenkinsci.plugins.workflow.flow
 
GraphListener - Interface in org.jenkinsci.plugins.workflow.flow
GraphListeners can be used in two different ways: either as an Extension, which will have its GraphListener.onNewHead(FlowNode) fired for every FlowExecution, or by instantiation and being passed to FlowExecution.addListener(GraphListener), in which case only events for that specific FlowExecution will be fired.
GraphListener.Synchronous - Interface in org.jenkinsci.plugins.workflow.flow
Listener which should be notified of events immediately as they occur.
GraphLookupView - Interface in org.jenkinsci.plugins.workflow.graph
Interface that can be exposed by objects providing means to easily look up information about the structure of a pipeline run Usually this is scoped to a specific FlowExecution.
GraphLookupView.EnclosingBlocksIterable - Class in org.jenkinsci.plugins.workflow.graph
Provides a trivial implementation to facilitate implementing GraphLookupView.iterateEnclosingBlocks(FlowNode)

H

handleChunkDone(MemoryFlowChunk) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
Override me to do something once the chunk is finished (such as add it to a list).
hasActionPredicate(Class<? extends Action>) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.FlowScanningUtils
Create a predicate that will match on all FlowNodes having a specific action present
hashCode() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner
Needs to be overridden as the FlowExecutionOwner.equals(Object) method is overridden.
hashCode() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
hasNext() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 

I

ID_ORDER_COMPARATOR - Static variable in class org.jenkinsci.plugins.workflow.graphanalysis.FlowScanningUtils
 
internalGraphLookup - Variable in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
interrupt(Result, CauseOfInterruption...) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Interrupts the execution of a flow.
isActive() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Checks whether a node is still part of the active part of the graph.
isActive(FlowNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
isActive(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graph.GraphLookupView
Tests if the node is a currently running head, or the start of a block that has not completed executing
isActive(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
isAtomicWrite() - Method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
Should we try to use an atomic write to protect from corrupting data with failures and errors during writes?
isChunkEnd(FlowNode, FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.BlockChunkFinder
 
isChunkEnd(FlowNode, FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.ChunkFinder
Test if the current node is the end of a chunk (inclusive)
isChunkEnd(FlowNode, FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LabelledChunkFinder
End is where the previous node is a chunk start or this is a BlockEndNode whose BlockStartNode has a label action
isChunkStart(FlowNode, FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.BlockChunkFinder
 
isChunkStart(FlowNode, FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.ChunkFinder
Test if the current node is the start of a new chunk (inclusive)
isChunkStart(FlowNode, FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LabelledChunkFinder
Start is anywhere with a LabelAction
isComplete() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Checks whether this flow execution has finished executing completely.
isCurrentHead(FlowNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Short for getCurrentHeads().contains(n) but more efficient.
isExecuted(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.actions.NotExecutedNodeAction
 
isOversized(Object) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Check for single oversized fields much like ArgumentsAction.isOversized(Object, int) but using ArgumentsAction.MAX_RETAINED_LENGTH.
isOversized(Object, int) - Static method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Provides a basic check if an object contains any excessively large collection/array/string elements with more than maxElements in them.
isParallelEnd(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
isParallelStart(FlowNode) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
isPersistWithEveryStep() - Method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
If false, the flow has to complete one way or the other in order to be persisted.
isResumeBlocked() - Method in interface org.jenkinsci.plugins.workflow.flow.BlockableResume
Return true if we prevent the abiity to resume.
isRunning() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Deprecated.
Usually FlowNode.isActive() is what you want. If you really wanted the original behavior, use FlowExecution.isCurrentHead(org.jenkinsci.plugins.workflow.graph.FlowNode).
isStartInsideChunk() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.BlockChunkFinder
NOTE: you will need to handle cases where you have a BlockStartNode where the BlockEndNode has not been generated yet! This means you need to keep nodes around even after hitting the EndNode
isStartInsideChunk() - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.ChunkFinder
If true, a chunk is implicitly created whenever we begin.
isStartInsideChunk() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LabelledChunkFinder
 
isUnmodifiedArguments() - Method in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Test if Step arguments are persisted in an unaltered form.
isWalkingFromFinish() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
If true, we are walking from the flow end node and have a complete view of the flow Needed because there are implications when not walking from a finished flow (blocks without a BlockEndNode)
itemInQueue() - Method in class org.jenkinsci.plugins.workflow.actions.QueueItemAction
Gets the Queue.Item for this task, if it exists.
ItemListenerImpl() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecutionList.ItemListenerImpl
 
iterateEnclosingBlocks() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Return an iterator over all enclosing blocks, from the nearest-enclosing outward ("inside-out" order).
iterateEnclosingBlocks(FlowNode) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
 
iterateEnclosingBlocks(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graph.GraphLookupView
Provide an Iterable over all enclosing blocks, which can be used similarly to GraphLookupView.findAllEnclosingBlockStarts(FlowNode) but does lazy fetches rather than materializing a full result.
iterateEnclosingBlocks(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
 
iterator() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
Lists all the current FlowExecutionOwners.
iterator() - Method in class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
Unlike Iterable.iterator(), this may be iterated only once.
iterator() - Method in class org.jenkinsci.plugins.workflow.graph.GraphLookupView.EnclosingBlocksIterable
 
iterator() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 

J

JoinNode - Class in org.jenkinsci.plugins.workflow.graph
Deprecated.
unused
JoinNode(FlowExecution, String, ForkNode, List<FlowNode>) - Constructor for class org.jenkinsci.plugins.workflow.graph.JoinNode
Deprecated.
 
jumpBlockScan(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearBlockHoppingScanner
Keeps jumping over blocks until we hit the first node preceding a block

L

LabelAction - Class in org.jenkinsci.plugins.workflow.actions
To mark FlowNode with human readable label, like stages.
LabelAction(String) - Constructor for class org.jenkinsci.plugins.workflow.actions.LabelAction
 
LabelledChunkFinder - Class in org.jenkinsci.plugins.workflow.graphanalysis
Splits a flow execution into FlowChunks whenever you have a label.
LabelledChunkFinder() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.LabelledChunkFinder
 
lastNode - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
LAUNCHED - org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
The Queue.Item has actually launched, meaning it has left the queue and there is a WorkspaceAction present on the FlowNode.
LinearBlockHoppingScanner - Class in org.jenkinsci.plugins.workflow.graphanalysis
Extension of LinearScanner that skips nested blocks at the current level, useful for finding enclosing blocks.
LinearBlockHoppingScanner() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.LinearBlockHoppingScanner
 
LinearScanner - Class in org.jenkinsci.plugins.workflow.graphanalysis
Scans through the flow graph in strictly linear fashion, visiting only the first branch in parallel blocks.
LinearScanner() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
 
Listener() - Constructor for class org.jenkinsci.plugins.workflow.FilePathUtils.Listener
 
loadActions(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graph.FlowActionStorage
Service for FlowNode to load its actions.
LogAction - Class in org.jenkinsci.plugins.workflow.actions
Associated with a node which has some log text.
LogAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.LogAction
 
LogStorage - Interface in org.jenkinsci.plugins.workflow.log
Means of replacing how logs are stored for a Pipeline build as a whole or for one step.
LogStorageFactory - Interface in org.jenkinsci.plugins.workflow.log
Factory interface for LogStorage.

M

MASKED_VALUE - org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason
Denotes an unsafe value that cannot be stored/displayed due to sensitive info.
MATCH_BLOCK_START - Static variable in class org.jenkinsci.plugins.workflow.graphanalysis.FlowScanningUtils
 
MAX_LIST_CHECK_SIZE - Static variable in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
When checking for denylist membership, we convert to a hashset when checking more than this many elements
MAX_RETAINED_LENGTH - Static variable in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Largest String, Collection, or array size we'll retain -- provides a rough size limit on any single field.
MAX_SURVIVABILITY - org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
 
maybeClearAll(Run<?, ?>) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
maybeClearAll(Run<?, ?>, TaskListener) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Delete any and all stashes in a build unless told otherwise.
MemoryFlowChunk - Class in org.jenkinsci.plugins.workflow.graphanalysis
FlowChunk that holds direct references to the FlowNode instances and context info This makes it easy to use in analysis and visualizations, but inappropriate to retain in caches, etc
MemoryFlowChunk() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
MemoryFlowChunk(FlowNode, FlowNode, FlowNode, FlowNode) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
merge(TaskListenerDecorator, TaskListenerDecorator) - Static method in class org.jenkinsci.plugins.workflow.log.TaskListenerDecorator
Merges two decorators.
Messages - Class in org.jenkinsci.plugins.workflow.flow
Generated localization support class.
Messages() - Constructor for class org.jenkinsci.plugins.workflow.flow.Messages
 
MoreExecutors - Class in org.jenkinsci.plugins.workflow.flow
Factory and utility methods for Executor, ExecutorService, and ThreadFactory.
myBlackList - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
myCurrent - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
myNext - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 

N

next() - Method in class org.jenkinsci.plugins.workflow.graph.FlowGraphWalker
Deprecated.
This class is Iterable now. Use FlowGraphWalker.iterator() instead.
next() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
next() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
next(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Actual meat of the iteration, get the next node to visit, using and updating state as needed
next(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
next(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
next(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearBlockHoppingScanner
 
next(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
 
nodeAfter - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
nodeBefore - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
nodeListener(FlowNode) - Method in class org.jenkinsci.plugins.workflow.log.BrokenLogStorage
 
nodeListener(FlowNode) - Method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
 
nodeListener(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Provides an alternate way of emitting output from a node (such as a step).
NodeStepNamePredicate - Class in org.jenkinsci.plugins.workflow.graphanalysis
Predicate that matches FlowNodes (specifically StepNodes) with a specific StepDescriptor name.
NodeStepNamePredicate(String) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepNamePredicate
 
NodeStepTypePredicate - Class in org.jenkinsci.plugins.workflow.graphanalysis
Predicate that matches FlowNodes (specifically StepNodes) with a specific StepDescriptor type.
NodeStepTypePredicate(String) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepTypePredicate
Create a filter predicate based on the step name
NodeStepTypePredicate(StepDescriptor) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.NodeStepTypePredicate
 
NotExecutedNodeAction - Class in org.jenkinsci.plugins.workflow.actions
Action that marks a node as being non-executed.
NotExecutedNodeAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.NotExecutedNodeAction
 
notifyOfNewStep(Step, StepContext) - Method in interface org.jenkinsci.plugins.workflow.flow.StepListener
Called before a Step is invoked, but after its FlowNode and StepContext have been created.
notifyShutdown() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Perform shutdown-specific logic -- should be invoked by the FlowExecutionOwner.notifyShutdown() method in response to FlowExecutionList.saveAll()

O

of(FlowExecutionOwner) - Static method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Gets the available log storage method for a given build.
of(FlowExecutionOwner) - Method in interface org.jenkinsci.plugins.workflow.log.TaskListenerDecorator.Factory
Supplies a decorator applicable to one build.
onCompleted(FlowExecution) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
Called when a FlowExecution has completed.
onCreated(FlowExecution) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
Called when a FlowExecution has been created, but before it starts running.
onLoad() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Deprecated.
onLoad(FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Should be called by the flow owner after it is deserialized.
onLoad(FlowNode) - Method in class org.jenkinsci.plugins.workflow.actions.BodyInvocationAction
 
onLoad(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.actions.FlowNodeAction
Called by FlowActionStorage.loadActions(FlowNode) when actions get loaded from persistent storage.
onLoaded() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList.ItemListenerImpl
 
onNewHead(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.flow.GraphListener
FlowExecution should batch up changes to a group and call this once, as opposed to call this for every new node added.
onNewHead(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
Update with a new node added to the flowgraph
onOnline(Computer, TaskListener) - Method in class org.jenkinsci.plugins.workflow.FilePathUtils.Listener
 
onResumed(FlowExecution) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
Called when a FlowExecution has resumed.
onRunning(FlowExecution) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionListener
Called when a FlowExecution has started running.
ordinal() - Method in interface org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider
 
org.jenkinsci.plugins.workflow - package org.jenkinsci.plugins.workflow
 
org.jenkinsci.plugins.workflow.actions - package org.jenkinsci.plugins.workflow.actions
 
org.jenkinsci.plugins.workflow.flow - package org.jenkinsci.plugins.workflow.flow
 
org.jenkinsci.plugins.workflow.graph - package org.jenkinsci.plugins.workflow.graph
 
org.jenkinsci.plugins.workflow.graphanalysis - package org.jenkinsci.plugins.workflow.graphanalysis
Provides a library of methods to work with and analyze the graph of FlowNodes produced from a pipeline execution.
org.jenkinsci.plugins.workflow.log - package org.jenkinsci.plugins.workflow.log
APIs supporting the production and retrieval of log messages associated with Pipeline builds (FlowExecutionOwner) and individual steps (FlowNode).
org.jenkinsci.plugins.workflow.pickles - package org.jenkinsci.plugins.workflow.pickles
 
org.jenkinsci.plugins.workflow.visualization.table - package org.jenkinsci.plugins.workflow.visualization.table
 
overallListener() - Method in class org.jenkinsci.plugins.workflow.log.BrokenLogStorage
 
overallListener() - Method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
 
overallListener() - Method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Provides an alternate way of emitting output from a build.
overallLog(FlowExecutionOwner.Executable, boolean) - Method in class org.jenkinsci.plugins.workflow.log.BrokenLogStorage
 
overallLog(FlowExecutionOwner.Executable, boolean) - Method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
 
overallLog(FlowExecutionOwner.Executable, boolean) - Method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Provides an alternate way of retrieving output from a build.
OVERSIZE_VALUE - org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason
Denotes an object that is too big to retain, such as strings exceeding ArgumentsAction.MAX_RETAINED_LENGTH

P

parallelBranchEnd(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Hit the end start of a parallel branch
parallelBranchEnd(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
parallelBranchStart(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Hit the start of a parallel branch
parallelBranchStart(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
parallelEnd(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Notifies that we've seen the end of a parallel block
parallelEnd(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
ParallelFlowChunk<ChunkType extends FlowChunk> - Interface in org.jenkinsci.plugins.workflow.graphanalysis
FlowChunk mapping to the block from a Parallel step (with parallel branches inside)
ParallelMemoryFlowChunk - Class in org.jenkinsci.plugins.workflow.graphanalysis
Corresponds to a parallel block, acts as an in-memory container that can plug into status/timing APIs
ParallelMemoryFlowChunk(FlowNode, FlowNode) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.ParallelMemoryFlowChunk
 
ParallelMemoryFlowChunk(FlowNode, FlowNode, FlowNode, FlowNode) - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.ParallelMemoryFlowChunk
 
parallelStart(FlowNode, FlowNode, ForkScanner) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.SimpleChunkVisitor
Notifies that we've hit the start of a parallel block (the point where it branches out).
parallelStart(FlowNode, FlowNode, ForkScanner) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
PERFORMANCE_OPTIMIZED - org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
 
PersistentAction - Interface in org.jenkinsci.plugins.workflow.actions
This is a marker interface for an action that can't be contributed by a TransientActionFactory.
Pickle - Class in org.jenkinsci.plugins.workflow.pickles
Handle value objects to replace another stateful objects that cannot be serialized on its own, such as FilePath.
Pickle() - Constructor for class org.jenkinsci.plugins.workflow.pickles.Pickle
 
PickleFactory - Class in org.jenkinsci.plugins.workflow.pickles
Provides a way of converting transient objects into Pickles.
PickleFactory() - Constructor for class org.jenkinsci.plugins.workflow.pickles.PickleFactory
 
possibleParallelStart(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
preOnline(Computer, Channel, FilePath, TaskListener) - Method in class org.jenkinsci.plugins.workflow.FilePathUtils.Listener
 

Q

queue - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
QUEUED - org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
The Queue.Item is currently in the queue.
QueueItemAction - Class in org.jenkinsci.plugins.workflow.actions
Records information for a node block.
QueueItemAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.QueueItemAction
 
QueueItemAction.QueueState - Enum in org.jenkinsci.plugins.workflow.actions
Possible queue states for the item associated with this FlowNode.

R

readResolve() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 
register(FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
It is the responsibility of the FlowExecutionOwner to register itself before it starts executing.
rehydrate() - Method in class org.jenkinsci.plugins.workflow.pickles.Pickle
Deprecated.
rehydrate(FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.pickles.Pickle
Start preparing rehydration of this value, and when it's ready or fail, report that to the given call.
remove() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
 
removeListener(GraphListener) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
removeTag(String) - Method in class org.jenkinsci.plugins.workflow.actions.TagsAction
Remove a tag mapping Input is CheckForNull so you can directly pass in values without nullchecks upfront.
reset() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Reset internal state so that we can begin walking a new flow graph Public APIs need to invoke this before searches
reset() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
reset() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
reset() - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
 
resetChunk(MemoryFlowChunk) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 

S

save() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
Explicitly save all the actions in this FlowNode.
saveActions(FlowNode, List<Action>) - Method in interface org.jenkinsci.plugins.workflow.graph.FlowActionStorage
Service for FlowNode to load its actions.
saveAll() - Static method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
 
setActions(List<Action>) - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
SPI for subtypes to directly manipulate the actions field.
setAnnotator(ConsoleAnnotator<?>) - Static method in class org.jenkinsci.plugins.workflow.log.ConsoleAnnotators
What to call at the end of an override of AnnotatedLargeText.writeHtmlTo(long, java.io.Writer).
setBranch(String, ChunkType) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.ParallelFlowChunk
 
setBranch(String, MemoryFlowChunk) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ParallelMemoryFlowChunk
 
setDurabilityHint(FlowDurabilityHint) - Method in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel.DescriptorImpl
 
setFirstNode(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
setHeads(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Set up to begin flow scanning using the filteredHeads as starting points This method makes several assumptions: - AbstractFlowScanner.reset() has already been invoked to reset state - filteredHeads has already had any points in AbstractFlowScanner.myBlackList removed - none of the filteredHeads are null
setHeads(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
setHeads(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
setHeads(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearBlockHoppingScanner
 
setHeads(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Set up to begin flow scanning using the filteredHeads as starting points This method makes several assumptions: - AbstractFlowScanner.reset() has already been invoked to reset state - filteredHeads has already had any points in AbstractFlowScanner.myBlackList removed - none of the filteredHeads are null
setLastNode(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
setNodeAfter(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
setNodeBefore(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
setParallelStartPredicate(Predicate<FlowNode>) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
Deprecated.
setPauseTimeMillis(long) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.MemoryFlowChunk
 
setResumeBlocked(boolean) - Method in interface org.jenkinsci.plugins.workflow.flow.BlockableResume
Set resume on or off - may throw an IllegalArgumentException if trying to illegally toggle.
setup(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Helper: version of AbstractFlowScanner.setup(Collection, Collection) where we don't have any nodes to denylist
setup(Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
setup(Collection<FlowNode>, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Set up for iteration/analysis on a graph of nodes, initializing the internal state Includes null-checking on arguments to allow directly calling with unchecked inputs (simplifies use).
setup(Collection<FlowNode>, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearBlockHoppingScanner
 
setup(Collection<FlowNode>, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
setup(FlowNode) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Helper: version of AbstractFlowScanner.setup(Collection, Collection) where we don't have any nodes to denylist and have just a single head
setup(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Helper: version of AbstractFlowScanner.setup(Collection, Collection) where we don't have any nodes to denylist, and have just a single head
shouldClearAll(Run<?, ?>) - Method in class org.jenkinsci.plugins.workflow.flow.StashManager.StashBehavior
Allows the normal clearing behavior to be suppressed.
SimpleChunkVisitor - Interface in org.jenkinsci.plugins.workflow.graphanalysis
This visitor's callbacks are invoked as we walk through a pipeline flow graph, and it splits it into chunks.
StageAction - Interface in org.jenkinsci.plugins.workflow.actions
Attached to a FlowNode to indicate that it entered a “stage” of a build.
StandardActions() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowCopier.StandardActions
 
StandardChunkVisitor - Class in org.jenkinsci.plugins.workflow.graphanalysis
Simple handler for linear FlowChunks (basic stages, etc), and designed to be extended.
StandardChunkVisitor() - Constructor for class org.jenkinsci.plugins.workflow.graphanalysis.StandardChunkVisitor
 
StandardGraphLookupView - Class in org.jenkinsci.plugins.workflow.graph
Provides overall insight into the structure of a flow graph...
StandardGraphLookupView() - Constructor for class org.jenkinsci.plugins.workflow.graph.StandardGraphLookupView
Create a lookup view for an execution
start() - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecution
Called after FlowDefinition.create(FlowExecutionOwner, List) to initiate the execution.
startStep(String) - Static method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Introduces an HTML block with a pipeline-node-<ID> CSS class based on FlowNode.getId().
stash(Run<?, ?>, String, FilePath, Launcher, EnvVars, TaskListener, String, String, boolean, boolean) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Saves a stash of some files from a build.
stash(Run<?, ?>, String, FilePath, TaskListener, String, String) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
stash(Run<?, ?>, String, FilePath, TaskListener, String, String, boolean) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
stash(Run<?, ?>, String, FilePath, TaskListener, String, String, boolean, boolean) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
stash(String, FilePath, Launcher, EnvVars, TaskListener, String, String, boolean, boolean) - Method in interface org.jenkinsci.plugins.workflow.flow.StashManager.StashAwareArtifactManager
 
StashBehavior() - Constructor for class org.jenkinsci.plugins.workflow.flow.StashManager.StashBehavior
 
stashesOf(Run<?, ?>) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
 
StashManager - Class in org.jenkinsci.plugins.workflow.flow
Manages per-build stashes of files.
StashManager.CopyStashesAndArtifacts - Class in org.jenkinsci.plugins.workflow.flow
 
StashManager.StashAwareArtifactManager - Interface in org.jenkinsci.plugins.workflow.flow
Mixin interface for an ArtifactManager which supports specialized stash behavior as well.
StashManager.StashBehavior - Class in org.jenkinsci.plugins.workflow.flow
Extension point for customizing behavior of stashes from other plugins.
StepExecutionIteratorImpl() - Constructor for class org.jenkinsci.plugins.workflow.flow.FlowExecutionList.StepExecutionIteratorImpl
 
StepListener - Interface in org.jenkinsci.plugins.workflow.flow
StepListeners are fired before invoking a step but after the FlowNode has been created and the StepContext has been populated.
stepLog(FlowNode, boolean) - Method in class org.jenkinsci.plugins.workflow.log.BrokenLogStorage
 
stepLog(FlowNode, boolean) - Method in class org.jenkinsci.plugins.workflow.log.FileLogStorage
 
stepLog(FlowNode, boolean) - Method in interface org.jenkinsci.plugins.workflow.log.LogStorage
Provides an alternate way of retrieving output from a build.
StepNode - Interface in org.jenkinsci.plugins.workflow.graph
Optional interface for a FlowNode that has an associated StepDescriptor.
SUGGESTED_DURABILITY_HINT - Static variable in class org.jenkinsci.plugins.workflow.flow.GlobalDefaultFlowDurabilityLevel
Currently suggested durability level for pipelines.
suggestedFor(Item) - Static method in interface org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider
 
suggestFor(Item) - Method in interface org.jenkinsci.plugins.workflow.flow.DurabilityHintProvider
 
SURVIVABLE_NONATOMIC - org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
 

T

TagsAction - Class in org.jenkinsci.plugins.workflow.actions
Tracks arbitrary annotations on FlowNode used for a variety of purposes This is designed to have a single action on the FlowNode to track all tags, for sanity.
TagsAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.TagsAction
 
TaskListenerDecorator - Class in org.jenkinsci.plugins.workflow.log
A way of decorating output from a TaskListener.
TaskListenerDecorator() - Constructor for class org.jenkinsci.plugins.workflow.log.TaskListenerDecorator
 
TaskListenerDecorator.Factory - Interface in org.jenkinsci.plugins.workflow.log
Allows a decorator to be applied to any build.
testCandidate(FlowNode, Collection<FlowNode>) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
ThreadNameAction - Interface in org.jenkinsci.plugins.workflow.actions
Thread name action.
TIME_ORDER_COMPARATOR - Static variable in class org.jenkinsci.plugins.workflow.graphanalysis.FlowScanningUtils
Sorts flownodes putting the one begun last (oldest startTime) at the end, with null times last because likely they represent the newest nodes with a TimingAction not attached yet.
TimingAction - Class in org.jenkinsci.plugins.workflow.actions
Action to add timestamp metadata to a FlowNode.
TimingAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.TimingAction
 
toString() - Method in class org.jenkinsci.plugins.workflow.graph.FlowNode
 

U

UNKNOWN - org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
The FlowNode has neither a QueueItemAction nor a WorkspaceAction, so its queue status cannot be determined.
unregister(FlowExecutionOwner) - Method in class org.jenkinsci.plugins.workflow.flow.FlowExecutionList
 
UNSERIALIZABLE - org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason
For when we can't actually serialize the arguments.
unstash(Run<?, ?>, String, FilePath, Launcher, EnvVars, TaskListener) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Restores a stash of some files from a build.
unstash(Run<?, ?>, String, FilePath, TaskListener) - Static method in class org.jenkinsci.plugins.workflow.flow.StashManager
Deprecated.
unstash(String, FilePath, Launcher, EnvVars, TaskListener) - Method in interface org.jenkinsci.plugins.workflow.flow.StashManager.StashAwareArtifactManager
 

V

valueOf(String) - Static method in enum org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jenkinsci.plugins.workflow.actions.QueueItemAction.QueueState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jenkinsci.plugins.workflow.flow.FlowDurabilityHint
Returns an array containing the constants of this enum type, in the order they are declared.
visit(FlowNode) - Method in interface org.jenkinsci.plugins.workflow.graphanalysis.FlowNodeVisitor
Visit the flow node, and indicate if we should continue analysis
visitAll(Collection<FlowNode>, Collection<FlowNode>, FlowNodeVisitor) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Given a FlowNodeVisitor, invoke FlowNodeVisitor.visit(FlowNode) on each node and halt early if it returns false.
visitAll(Collection<FlowNode>, Collection<FlowNode>, FlowNodeVisitor) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Given a FlowNodeVisitor, invoke FlowNodeVisitor.visit(FlowNode) on each node and halt early if it returns false.
visitAll(Collection<FlowNode>, FlowNodeVisitor) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.AbstractFlowScanner
Syntactic sugar for AbstractFlowScanner.visitAll(Collection, Collection, FlowNodeVisitor) where we don't denylist any nodes
visitAll(Collection<FlowNode>, FlowNodeVisitor) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.LinearScanner
Syntactic sugar for AbstractFlowScanner.visitAll(Collection, Collection, FlowNodeVisitor) where we don't denylist any nodes
visited - Variable in class org.jenkinsci.plugins.workflow.graphanalysis.DepthFirstScanner
 
visitSimpleChunks(Collection<FlowNode>, Collection<FlowNode>, SimpleChunkVisitor, ChunkFinder) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
visitSimpleChunks(Collection<FlowNode>, SimpleChunkVisitor, ChunkFinder) - Static method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
 
visitSimpleChunks(SimpleChunkVisitor, ChunkFinder) - Method in class org.jenkinsci.plugins.workflow.graphanalysis.ForkScanner
Walk through flows

W

WarningAction - Class in org.jenkinsci.plugins.workflow.actions
Action to be attached to a FlowNode to signify that some non-fatal event occurred during execution of a Step but execution continued normally.
WarningAction(Result) - Constructor for class org.jenkinsci.plugins.workflow.actions.WarningAction
 
withMessage(String) - Method in class org.jenkinsci.plugins.workflow.actions.WarningAction
 
WorkspaceAction - Class in org.jenkinsci.plugins.workflow.actions
Represents the fact that a step run on a particular workspace.
WorkspaceAction() - Constructor for class org.jenkinsci.plugins.workflow.actions.WorkspaceAction
 
writeReplace(Object) - Method in class org.jenkinsci.plugins.workflow.pickles.PickleFactory
 

_

_FlowDurabilityHint_MAX_SURVIVABILITY_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.MAX_SURVIVABILITY.description: Maximum durability but slowest (previously the only option).
_FlowDurabilityHint_MAX_SURVIVABILITY_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.MAX_SURVIVABILITY.tooltip: Writes data with every step, using atomic writes for integrity. Provides maximum ability to retain running pipeline data and resume in the event of a Jenkins failure..
_FlowDurabilityHint_PERFORMANCE_OPTIMIZED_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.PERFORMANCE_OPTIMIZED.description: Performance-optimized: much faster (requires clean shutdown to save running pipelines).
_FlowDurabilityHint_PERFORMANCE_OPTIMIZED_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.PERFORMANCE_OPTIMIZED.tooltip: Avoids writing data with every step, avoids atomic writes of data. Pipelines can resume if Jenkins shuts down cleanly, but running pipelines lose step information and cannot resume if Jenkins unexpectedly fails..
_FlowDurabilityHint_SURVIVABLE_NONATOMIC_description() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.SURVIVABLE_NONATOMIC.description: Less durability, a bit faster (specialty use only).
_FlowDurabilityHint_SURVIVABLE_NONATOMIC_tooltip() - Static method in class org.jenkinsci.plugins.workflow.flow.Messages
Key FlowDurabilityHint.SURVIVABLE_NONATOMIC.tooltip: Writes data with every step but avoids atomic writes. On some filesytems this is faster than maximum durability mode, but running pipeline data may be lost if disk writes are interrupted or fail..
A B C D E F G H I J L M N O P Q R S T U V W _ 
All Classes All Packages