Package jetbrains.buildServer.serverSide

Interface BuildStartContext

All Known Implementing Classes:

BuildStartContextImpl

public interface BuildStartContext

Context of parameters that will be send to the build agent to start the build.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
void	addSharedParameter(String key, String value)	Adds a build parameter which should be available to all of the steps.
SRunningBuild	getBuild()
Collection<? extends SRunnerContext>	getRunnerContexts()
Map<String,String>	getSharedParameters()	Returns the map of build parameters shared among all of the steps.

Method Detail

getBuild

@NotNull
SRunningBuild getBuild()

Returns:

running build that will be sent to a build agent

Since:

6.0

getSharedParameters

@NotNull
Map<String,String> getSharedParameters()

Returns the map of build parameters shared among all of the steps. Use Constants.SYSTEM_PREFIX for system properties and Constants.ENV_PREFIX for environment variables. Parameters without these prefixes are treated as configuration parameters.

Returns:

shared parameters readonly map

Since:

6.0

addSharedParameter

void addSharedParameter(@NotNull
                        String key,
                        @NotNull
                        String value)

Adds a build parameter which should be available to all of the steps. Use Constants.SYSTEM_PREFIX for system properties and Constants.ENV_PREFIX for environment variables. Parameters without prefix are configuration parameters

Parameters:

key - key

value - value

Since:

6.0

getRunnerContexts

@NotNull
Collection<? extends SRunnerContext> getRunnerContexts()

Returns:

unordered collection of build runner contexts

Since:

6.0