Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractStepDescriptorImpl - Class in org.jenkinsci.plugins.workflow.steps
 - 
Deprecated.
 - AbstractStepDescriptorImpl(Class<? extends StepExecution>) - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl
 - 
Deprecated.
 - AbstractStepExecutionImpl - Class in org.jenkinsci.plugins.workflow.steps
 - 
Partial implementation of
StepExecutionthat injectsStepContextParameterupon resume. - AbstractStepExecutionImpl() - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
 - 
Deprecated.Directly extend
StepExecutionand avoid Guice for a new step. Or seeAbstractStepExecutionImpl(StepContext)for an existing step. - AbstractStepExecutionImpl(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
 - 
Constructor for compatibility.
 - AbstractStepImpl - Class in org.jenkinsci.plugins.workflow.steps
 - 
Partial convenient step implementation.
 - AbstractStepImpl() - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
 - 
Deprecated.Directly extend
Stepand avoid Guice. Or seeAbstractStepImpl(boolean)for an existing step. - AbstractStepImpl(boolean) - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
 - 
Constructor for compatibility.
 - AbstractSynchronousNonBlockingStepExecution<T> - Class in org.jenkinsci.plugins.workflow.steps
 - 
Deprecated.Extend
SynchronousNonBlockingStepExecutionand avoid Guice. - AbstractSynchronousNonBlockingStepExecution() - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.
 - AbstractSynchronousNonBlockingStepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.
 - AbstractSynchronousStepExecution<T> - Class in org.jenkinsci.plugins.workflow.steps
 - 
Deprecated.Extend
SynchronousStepExecutionand avoid Guice. - AbstractSynchronousStepExecution() - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution
 - 
Deprecated.
 - AbstractSynchronousStepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution
 - 
Deprecated.
 - accept(Consumer<StepExecution>) - Method in class org.jenkinsci.plugins.workflow.steps.StepExecutionIterator
 - 
Finds all the ongoing
StepExecutionand apply the action. - acceptAll(Class<T>, Consumer<T>) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Applies only to the specific subtypes.
 - acceptAll(Consumer<StepExecution>) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Apply the given action to all the active running
StepExecutions in the system. - all() - Static method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - all() - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutionIterator
 - allMeta() - Static method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Convenience method to iterate all meta step descriptors.
 - apply(Function<StepExecution, Void>) - Method in class org.jenkinsci.plugins.workflow.steps.StepExecutionIterator
 - apply(StepContext, Throwable) - Static method in interface org.jenkinsci.plugins.workflow.steps.FailureHandler
 - 
Looks up in the current context for a
FailureHandlerand runs it against the givenThrowable. - applyAll(Function<StepExecution, Void>) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Deprecated.
 - applyAll(Class<T>, Function<T, Void>) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Deprecated.
 - argumentsToString(Map<String, Object>) - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Converts user-supplied step arguments to a string for eventual UI use -- override me to handle more than a single trivial argument.
 - asReturn() - Method in interface org.jenkinsci.plugins.workflow.steps.StepExecutions.SynchronousBodyVoid
 
B
- block(StepContext, StepExecutions.BlockBody) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutions
 - 
Creates a block-scoped execution allowing various initial actions including
BodyInvoker.withContext(java.lang.Object). - blocksRestart() - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - blocksRestart() - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Allows a step to indicate that
AsynchronousExecution.blocksRestart()should be true. - blocksRestart() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - BodyExecution - Class in org.jenkinsci.plugins.workflow.steps
 - 
Represents the executing body block of
Step. - BodyExecution() - Constructor for class org.jenkinsci.plugins.workflow.steps.BodyExecution
 - BodyExecutionCallback - Class in org.jenkinsci.plugins.workflow.steps
 - 
FutureCallbackenhanced to trackBodyExecution. - BodyExecutionCallback() - Constructor for class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback
 - BodyExecutionCallback.TailCall - Class in org.jenkinsci.plugins.workflow.steps
 - 
A convenience subclass for the common case that the step expects to run its block just once and return the same value (or throw the same error).
 - BodyInvoker - Class in org.jenkinsci.plugins.workflow.steps
 - 
Builder pattern for controlling how to execute a body block of a
Step. - BodyInvoker() - Constructor for class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - buildEnvironmentFor(StepContext, EnvVars, TaskListener) - Method in class org.jenkinsci.plugins.workflow.steps.StepEnvironmentContributor
 - 
Contributes environment variables used for a workflow step.
 - byFunctionName(String) - Static method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Obtains a
StepDescriptorby its function name, or null if not found. 
C
- call(StepContext) - Method in interface org.jenkinsci.plugins.workflow.steps.StepExecutions.SynchronousBody
 - call(StepContext) - Method in interface org.jenkinsci.plugins.workflow.steps.StepExecutions.SynchronousBodyVoid
 - call(StepContext, BodyInvoker) - Method in interface org.jenkinsci.plugins.workflow.steps.StepExecutions.BlockBody
 - cancel(boolean) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecution
 - 
Deprecated.use
BodyExecution.cancel(Throwable)to provide richer context - cancel(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecution
 - 
Attempts to cancel an executing body block.
 - cancel(CauseOfInterruption...) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecution
 - 
Deprecated.
 - checkContextAvailability(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Makes sure that the given
StepContexthas all the context parameters this descriptor wants to see, and if not, throwMissingContextVariableExceptionindicating which variable is missing. - CLAZZ - Static variable in class org.jenkinsci.plugins.workflow.structs.DescribableHelper
 - 
Deprecated.
 - constant(Map<String, String>) - Static method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
Provides an expander for a constant map of string keys and string values.
 
D
- defineArguments(Step) - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Deprecated.
 - DescribableHelper - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.Moved to the structs plugin. See
DescribableModel - DescribableHelper.ArrayType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.
 - DescribableHelper.AtomicType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.
 - DescribableHelper.EnumType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.
 - DescribableHelper.ErrorType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.
 - DescribableHelper.HeterogeneousObjectType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.A parameter (or array element) which could take any of the indicated concrete object types.
 - DescribableHelper.HomogeneousObjectType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.
 - DescribableHelper.ParameterType - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.A type of a parameter to a class.
 - DescribableHelper.Schema - Class in org.jenkinsci.plugins.workflow.structs
 - 
Deprecated.Definition of how a particular class may be configured.
 - DynamicContext - Interface in org.jenkinsci.plugins.workflow.steps
 - 
Allows
StepContext.get(java.lang.Class<T>)to provide a dynamically computed value. - DynamicContext.DelegatedContext - Interface in org.jenkinsci.plugins.workflow.steps
 - 
Restricted version of
StepContextused only for delegation inDynamicContext.get(Class, DelegatedContext). - DynamicContext.Typed<T> - Class in org.jenkinsci.plugins.workflow.steps
 - 
A convenience subclass for the common case that you are returning only one kind of object.
 
E
- EnvironmentExpander - Class in org.jenkinsci.plugins.workflow.steps
 - 
Interface destined for
StepContext.get(java.lang.Class<T>)instead of rawEnvVars. - EnvironmentExpander() - Constructor for class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - equals(Object) - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
StepContexts get persisted, so they may not have the identity equality, but equals method would allow two instances to be compared. - expand(EnvVars) - Method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
May add environment variables to a context.
 
F
- FailureHandler - Interface in org.jenkinsci.plugins.workflow.steps
 - 
Interface destined for
StepContext.get(java.lang.Class<T>)to rewrite or wrapThrowables. - findItemFromRequest(Class<T>) - Static method in class org.jenkinsci.plugins.workflow.util.StaplerReferer
 - 
Like
StaplerRequest2.findAncestorObject(java.lang.Class<T>)except works also in configuration screens when a lazy-load section is newly added. - finished(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback.TailCall
 - 
Called when the body is finished.
 - finished(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.TailCall
 - 
Called when the body is finished.
 - FlowInterruptedException - Exception in org.jenkinsci.plugins.workflow.steps
 - 
Special exception that can be thrown out of
FutureCallback.onFailure(java.lang.Throwable)to indicate that the flow was aborted from the inside. - FlowInterruptedException(Result, boolean, CauseOfInterruption...) - Constructor for exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - 
Creates a new exception.
 - FlowInterruptedException(Result, CauseOfInterruption...) - Constructor for exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 
G
- GeneralNonBlockingStepExecution - Class in org.jenkinsci.plugins.workflow.steps
 - 
Generalization of
SynchronousNonBlockingStepExecutionthat can be used for block-scoped steps. - GeneralNonBlockingStepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - GeneralNonBlockingStepExecution.Block - Interface in org.jenkinsci.plugins.workflow.steps
 - 
Block to be passed to
GeneralNonBlockingStepExecution.Block.run(). - GeneralNonBlockingStepExecution.TailCall - Class in org.jenkinsci.plugins.workflow.steps
 - get(Class<T>) - Method in interface org.jenkinsci.plugins.workflow.steps.DynamicContext.DelegatedContext
 - 
Look for objects of the same or another type defined in this context.
 - get(Class<T>) - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Tries to find a contextually available object.
 - get(Class<T>, DynamicContext.DelegatedContext) - Method in interface org.jenkinsci.plugins.workflow.steps.DynamicContext
 - 
Actually look up a given object in a particular context.
 - get(Class<U>, DynamicContext.DelegatedContext) - Method in class org.jenkinsci.plugins.workflow.steps.DynamicContext.Typed
 - get(DynamicContext.DelegatedContext) - Method in class org.jenkinsci.plugins.workflow.steps.DynamicContext.Typed
 - getActualType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.ParameterType
 - 
Deprecated.
 - getCauses() - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - getContext() - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - getCurrentExecutions() - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecution
 - 
Returns the inner-most
StepExecutions that are currently executing. - getDescriptor() - Method in class org.jenkinsci.plugins.workflow.steps.Step
 - getDisplayName() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.Corresponds to
Descriptor.getDisplayName()where available. - getEffectiveEnvironment(EnvVars, EnvVars, EnvironmentExpander) - Static method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
Deprecated.
 - getEffectiveEnvironment(EnvVars, EnvVars, EnvironmentExpander, StepContext, TaskListener) - Static method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
Computes an effective environment in a given context.
 - getElementType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.ArrayType
 - 
Deprecated.The element type of the array or list.
 - getError() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.ErrorType
 - 
Deprecated.
 - getExecutionType() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl
 - 
Deprecated.
 - getFunctionName() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Return a short string that is a valid identifier for programming languages.
 - getHelp(String) - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.Loads help defined for this object as a whole or one of its parameters.
 - getMessage() - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - getMessage() - Method in exception org.jenkinsci.plugins.workflow.steps.MissingContextVariableException
 - getMetaStepArgumentType() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
For a meta step, return the type that this meta step handles.
 - getProvidedContext() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Returns the context
Stepadds/sets/modifies when executing a body. - getProviders() - Method in exception org.jenkinsci.plugins.workflow.steps.MissingContextVariableException
 - 
Returns
StepDescriptors with body that can provide a context of this type, so that the error message can diagnose what steps were likely missing. - getRequiredContext() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractStepDescriptorImpl
 - 
Deprecated.Looks for the fields and setter methods with
StepContextParameters and infer required contexts from there. - getRequiredContext() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Enumerates any kinds of context the
StepExecutionwill treat as mandatory. - getResult() - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - getSchemaType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HomogeneousObjectType
 - 
Deprecated.The schema representing a type of nested object.
 - getSensitiveVariables() - Method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
Get the names of environment variables known to contain sensitive values, such as secrets, in the current context.
 - getStatus() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.
 - getStatus() - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - getStatus() - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
May be overridden to provide specific information about what a step is currently doing, for diagnostic purposes.
 - getStatus() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - getStatusBounded(long, TimeUnit) - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Like
StepExecution.getStatus()but more robust. - getType() - Method in exception org.jenkinsci.plugins.workflow.steps.MissingContextVariableException
 - getType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.AtomicType
 - 
Deprecated.
 - getType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.EnumType
 - 
Deprecated.
 - getType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HeterogeneousObjectType
 - 
Deprecated.
 - getType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HomogeneousObjectType
 - 
Deprecated.
 - getType() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.A concrete class, usually
Describable. - getTypes() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HeterogeneousObjectType
 - 
Deprecated.A map from names which could be passed to
DescribableHelper.CLAZZto types of allowable nested objects. - getValues() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.EnumType
 - 
Deprecated.A list of enumeration values.
 
H
- handle(Run<?, ?>, TaskListener) - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - 
If a build catches this exception, it should use this method to report it.
 - handle(StepContext, Throwable) - Method in interface org.jenkinsci.plugins.workflow.steps.FailureHandler
 - 
Intercept the supplied
Throwable. - hasBody() - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Checks if this step was called with a body.
 - hashCode() - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Needs to be overridden as the
StepContext.equals(Object)method is overridden. 
I
- inject() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
 - 
Deprecated.
 - instantiate(Class<? extends T>, Map<String, ?>) - Static method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper
 - 
Deprecated.Creates an instance of a class via
DataBoundConstructorandDataBoundSetter. - isActualInterruption() - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - isAdvanced() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
For UI presentation purposes, allows a plugin to mark a step as deprecated or advanced.
 - isMetaStep() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Some steps, such as
CoreSteporGenericSCMStepcan take arbitraryDescribables of a certain type and execute it as a step. - isReady() - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Whether
StepContext.get(java.lang.Class<T>)is ready to return values. 
M
- mandatoryParameters() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.Mandatory (constructor) parameters, in order.
 - merge(EnvironmentExpander, EnvironmentExpander) - Static method in class org.jenkinsci.plugins.workflow.steps.EnvironmentExpander
 - 
Merge together two expanders.
 - merge(FailureHandler, FailureHandler) - Static method in interface org.jenkinsci.plugins.workflow.steps.FailureHandler
 - 
Merge together two
FailureHandler. - mergeConsoleLogFilters(ConsoleLogFilter, ConsoleLogFilter) - Static method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Merge two console log filters so that both are applied.
 - mergeLauncherDecorators(LauncherDecorator, LauncherDecorator) - Static method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Merge two launcher decorators so that both are applied.
 - metaStepsOf(String) - Static method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Given a symbol, attempt to find all the meta-steps that can consume this symbol.
 - MissingContextVariableException - Exception in org.jenkinsci.plugins.workflow.steps
 - 
Indicates that a required context was not available.
 - MissingContextVariableException(Class<?>) - Constructor for exception org.jenkinsci.plugins.workflow.steps.MissingContextVariableException
 - 
Deprecated.
 - MissingContextVariableException(Class<?>, StepDescriptor) - Constructor for exception org.jenkinsci.plugins.workflow.steps.MissingContextVariableException
 
N
- newBodyInvoker() - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Prepares for an asynchronous invocation of the body block that's given as an argument to this step invocation (in a host language dependent manner.)
 - newInstance(Map<String, Object>) - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Deprecated.instead use
CustomDescribableModel 
O
- onFailure(StepContext, Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback
 - 
Notifies that the body execution has aborted abnormally.
 - onFailure(StepContext, Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback.TailCall
 - onFailure(StepContext, Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.TailCall
 - onResume() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractStepExecutionImpl
 - 
Reinject
StepContextParameters. - onResume() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.
 - onResume() - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - onResume() - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Called when
StepExecutionis brought back into memory after restart. - onResume() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - onStart(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback
 - 
Notifies that the body execution has started.
 - onSuccess(Object) - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - onSuccess(StepContext, Object) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback
 - 
Notifies that the body execution has completed successfully.
 - onSuccess(StepContext, Object) - Method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback.TailCall
 - onSuccess(StepContext, Object) - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.TailCall
 - org.jenkinsci.plugins.workflow.steps - package org.jenkinsci.plugins.workflow.steps
 - org.jenkinsci.plugins.workflow.structs - package org.jenkinsci.plugins.workflow.structs
 - org.jenkinsci.plugins.workflow.util - package org.jenkinsci.plugins.workflow.util
 
P
- parameters() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.A map from parameter names to types.
 - prepareInjector(StepContext, Step) - Static method in class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
 
R
- run() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.Meat of the execution.
 - run() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution
 - 
Deprecated.Meat of the execution.
 - run() - Method in interface org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.Block
 - run() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - 
Meat of the execution.
 - run() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution
 - 
Meat of the execution.
 - run(GeneralNonBlockingStepExecution.Block) - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - 
Initiate background work that should not block the CPS VM thread.
 
S
- saveState() - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Requests that any state held by the
StepExecutionbe saved to disk. - schemaFor(Class<?>) - Static method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper
 - 
Deprecated.Loads a definition of the structure of a class: what kind of data you might get back from
DescribableHelper.uninstantiate(java.lang.Object)on an instance, or might want to pass toDescribableHelper.instantiate(java.lang.Class<? extends T>, java.util.Map<java.lang.String, ?>). - setActualInterruption(boolean) - Method in exception org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
 - setResult(Result) - Method in class org.jenkinsci.plugins.workflow.steps.StepContext
 - 
Sets the overall result of the flow.
 - StaplerReferer - Class in org.jenkinsci.plugins.workflow.util
 - 
JENKINS-19413 workaround.
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution
 - 
Deprecated.
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Schedules an asynchronous invocation of the body that's given as an argument to the step invocation (in a host language dependent manner), with settings configured on this object via other methods.
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Start execution of something and report the end result back to the given callback.
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - start() - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution
 - start(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
 - 
Constructs a step execution automatically according to
AbstractStepDescriptorImpl.getExecutionType(). - start(StepContext) - Method in class org.jenkinsci.plugins.workflow.steps.Step
 - 
Start execution of something and report the end result back to the given callback.
 - Step - Class in org.jenkinsci.plugins.workflow.steps
 - 
One thing that can be done, perhaps asynchronously.
 - Step() - Constructor for class org.jenkinsci.plugins.workflow.steps.Step
 - StepContext - Class in org.jenkinsci.plugins.workflow.steps
 - 
An implicit context available to every
Step. - StepContext() - Constructor for class org.jenkinsci.plugins.workflow.steps.StepContext
 - StepContextParameter - Annotation Interface in org.jenkinsci.plugins.workflow.steps
 - 
Deprecated.Call
StepContext.get(java.lang.Class<T>)as needed and avoid Guice. - StepDescriptor - Class in org.jenkinsci.plugins.workflow.steps
 - StepDescriptor() - Constructor for class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - StepEnvironmentContributor - Class in org.jenkinsci.plugins.workflow.steps
 - 
Contributes environment variables to workflow steps.
 - StepEnvironmentContributor() - Constructor for class org.jenkinsci.plugins.workflow.steps.StepEnvironmentContributor
 - StepExecution - Class in org.jenkinsci.plugins.workflow.steps
 - 
Scoped to a single execution of
Step, and provides insights into what's going on asynchronously and aborting the activity if need be. - StepExecution() - Constructor for class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
Deprecated.Avoid Guice.
 - StepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
If manually created,
StepContextmust be passed in. - StepExecutionIterator - Class in org.jenkinsci.plugins.workflow.steps
 - 
Enumerates active running
StepExecutions in the system. - StepExecutionIterator() - Constructor for class org.jenkinsci.plugins.workflow.steps.StepExecutionIterator
 - StepExecutions - Class in org.jenkinsci.plugins.workflow.steps
 - 
Builder for simple
StepExecutionimplementations. - StepExecutions.BlockBody - Interface in org.jenkinsci.plugins.workflow.steps
 - StepExecutions.SynchronousBody - Interface in org.jenkinsci.plugins.workflow.steps
 - StepExecutions.SynchronousBodyVoid - Interface in org.jenkinsci.plugins.workflow.steps
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousNonBlockingStepExecution
 - 
Deprecated.If the computation is going synchronously, try to cancel that.
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.AbstractSynchronousStepExecution
 - 
Deprecated.If the computation is going synchronously, try to cancel that.
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution
 - 
If the computation is going synchronously, try to cancel that.
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.StepExecution
 - 
May be called if someone asks a running step to abort.
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - 
If the computation is going synchronously, try to cancel that.
 - stop(Throwable) - Method in class org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution
 - 
If the computation is going synchronously, try to cancel that.
 - synchronous(StepContext, StepExecutions.SynchronousBody) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutions
 - 
Creates a
SynchronousStepExecutionrunning a given block with a return value. - synchronousNonBlocking(StepContext, StepExecutions.SynchronousBody) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutions
 - 
Creates a
SynchronousNonBlockingStepExecutionrunning a given block with a return value. - SynchronousNonBlockingStepExecution<T> - Class in org.jenkinsci.plugins.workflow.steps
 - 
Similar to
SynchronousStepExecution(it executes synchronously too) but it does not block the CPS VM thread. - SynchronousNonBlockingStepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution
 - synchronousNonBlockingVoid(StepContext, StepExecutions.SynchronousBodyVoid) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutions
 - 
Creates a
SynchronousNonBlockingStepExecutionrunning a given block. - SynchronousResumeNotSupportedException - Exception in org.jenkinsci.plugins.workflow.steps
 - 
May be reported from
StepExecution.onResume()when the step does not support resumption. - SynchronousResumeNotSupportedException() - Constructor for exception org.jenkinsci.plugins.workflow.steps.SynchronousResumeNotSupportedException
 - 
Deprecated.Use
SynchronousResumeNotSupportedException(StepContext)instead. - SynchronousResumeNotSupportedException(StepContext) - Constructor for exception org.jenkinsci.plugins.workflow.steps.SynchronousResumeNotSupportedException
 - SynchronousStepExecution<T> - Class in org.jenkinsci.plugins.workflow.steps
 - 
StepExecutionthat always executes synchronously. - SynchronousStepExecution(StepContext) - Constructor for class org.jenkinsci.plugins.workflow.steps.SynchronousStepExecution
 - synchronousVoid(StepContext, StepExecutions.SynchronousBodyVoid) - Static method in class org.jenkinsci.plugins.workflow.steps.StepExecutions
 - 
Creates a
SynchronousStepExecutionrunning a given block. 
T
- TailCall() - Constructor for class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback.TailCall
 - TailCall() - Constructor for class org.jenkinsci.plugins.workflow.steps.GeneralNonBlockingStepExecution.TailCall
 - takesImplicitBlockArgument() - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Return true if this step can accept an implicit block argument.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.ArrayType
 - 
Deprecated.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.AtomicType
 - 
Deprecated.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.EnumType
 - 
Deprecated.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.ErrorType
 - 
Deprecated.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HeterogeneousObjectType
 - 
Deprecated.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.HomogeneousObjectType
 - 
Deprecated.The actual class underlying the type.
 - toString() - Method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper.Schema
 - 
Deprecated.
 - type() - Method in class org.jenkinsci.plugins.workflow.steps.DynamicContext.Typed
 - 
A type token.
 - Typed() - Constructor for class org.jenkinsci.plugins.workflow.steps.DynamicContext.Typed
 
U
- uninstantiate(Object) - Static method in class org.jenkinsci.plugins.workflow.structs.DescribableHelper
 - 
Deprecated.Computes arguments suitable to pass to
DescribableHelper.instantiate(java.lang.Class<? extends T>, java.util.Map<java.lang.String, ?>)to reconstruct this object. - uninstantiate(Step) - Method in class org.jenkinsci.plugins.workflow.steps.StepDescriptor
 - 
Deprecated.instead use
CustomDescribableModel 
W
- withCallback(FutureCallback<Object>) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Deprecated.Use
BodyInvoker.withCallback(BodyExecutionCallback)and callBodyExecutionCallback.wrap(com.google.common.util.concurrent.FutureCallback<java.lang.Object>)if this is what you really wanted. - withCallback(BodyExecutionCallback) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Registers a callback that tracks the progress of the body execution.
 - withContext(Object) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Overrides to the context values that are in effect while evaluating the body.
 - withContexts(Object...) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Equivalent to calling
BodyInvoker.withContext(java.lang.Object)on each object. - withContexts(Collection<?>) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Equivalent to calling
BodyInvoker.withContext(java.lang.Object)on each object. - withDisplayName(String) - Method in class org.jenkinsci.plugins.workflow.steps.BodyInvoker
 - 
Sets a human readable name that describes this body invocation.
 - wrap(FutureCallback<Object>) - Static method in class org.jenkinsci.plugins.workflow.steps.BodyExecutionCallback
 - 
Wraps an ordinary
FutureCallbackintoBodyExecutionCallback. 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
StepDescriptorand avoid Guice.