Package hudson.model

Interface EnvironmentContributingAction

All Superinterfaces:

Action, ModelObject

All Known Implementing Classes:

ParametersAction

public interface EnvironmentContributingAction
extends Action

Action that contributes environment variables during a build.

For example, your Builder can add an EnvironmentContributingAction so that the rest of the builders or publishers see some behavior changes. Another use case is for you to submit a job with EnvironmentContributingActions.

Since:

1.318

Author:

Kohsuke Kawaguchi

See Also:

• Run.getEnvironment(TaskListener)
• BuildWrapper

Method Summary

Modifier and Type	Method	Description
default void	buildEnvironment(Run<?,?> run, EnvVars env)	Called by Run to allow plugins to contribute environment variables.
default void	buildEnvVars(AbstractBuild<?,?> build, EnvVars env)	Deprecated. Use buildEnvironment(hudson.model.Run<?, ?>, hudson.EnvVars) instead

Methods inherited from interface hudson.model.Action

getDisplayName, getIconFileName, getUrlName

Method Details

buildEnvironment

default void buildEnvironment(@NonNull
 Run<?,?> run,
 @NonNull
 EnvVars env)

Called by Run to allow plugins to contribute environment variables.

Parameters:

run - The calling build. Never null.

env - Environment variables should be added to this map.

Since:

2.76

buildEnvVars

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.ProtectedExternally.class)
default void buildEnvVars(AbstractBuild<?,?> build,
 EnvVars env)

Deprecated.

Use buildEnvironment(hudson.model.Run<?, ?>, hudson.EnvVars) instead

Called by AbstractBuild to allow plugins to contribute environment variables.

Parameters:

build - The calling build. Never null.

env - Environment variables should be added to this map.