Package org.jenkinsci.plugins.workflow.support.actions

Interface EnvironmentAction

All Superinterfaces:

Action, ModelObject

All Known Subinterfaces:

EnvironmentAction.IncludingOverrides

public interface EnvironmentAction
extends Action

A run action which reports environment variables. If present, will be used from DefaultStepContext.get(java.lang.Class<T>) on EnvVars after amendment by EnvironmentExpander.getEffectiveEnvironment(hudson.EnvVars, hudson.EnvVars, org.jenkinsci.plugins.workflow.steps.EnvironmentExpander).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EnvironmentAction.IncludingOverrides	Optional extension interface that allows the overrides to be distinguished.

Method Summary

Modifier and Type	Method	Description
EnvVars	getEnvironment()	Gets the complete global environment for a build, including both Run.getEnvironment(TaskListener) and any EnvironmentAction.IncludingOverrides.getOverriddenEnvironment().

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Method Detail

getEnvironment

EnvVars getEnvironment()
                throws IOException,
                       InterruptedException

Gets the complete global environment for a build, including both Run.getEnvironment(TaskListener) and any EnvironmentAction.IncludingOverrides.getOverriddenEnvironment().

Throws:

IOException

InterruptedException