Package jetbrains.buildServer.serverSide

Interface SRunnerContext

All Superinterfaces:

BuildRunnerDescriptor, ParametersDescriptor, SBuildRunnerDescriptor

All Known Subinterfaces:

RunnerStepContext

All Known Implementing Classes:

RunnerContextImpl

public interface SRunnerContext
extends SBuildRunnerDescriptor

Represents context of a single build step on the server side.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
void	addBuildParameter(String key, String value)	Adds build parameter to this build step.
void	addBuildParameters(Map<String,String> parameters)	Same as addBuildParameter(String, String) but accepts map
void	addRunnerParameter(String key, String value)	Adds a runner parameter.
Map<String,String>	getBuildParameters()	The readonly map of build step parameters.
boolean	isEnabled()

Methods inherited from interface jetbrains.buildServer.serverSide.BuildRunnerDescriptor

getName, getOwnBuildParameters

Methods inherited from interface jetbrains.buildServer.serverSide.ParametersDescriptor

getId, getParameters, getType

Methods inherited from interface jetbrains.buildServer.serverSide.SBuildRunnerDescriptor

getFullDisplayName, getInvalidProperties, getRunType, getRunTypeRequirements, getRunTypeWithExtensions

Method Detail

addRunnerParameter

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

Adds a runner parameter.

Parameters:

key - key

value - value

Since:

6.0

getBuildParameters

@NotNull
Map<String,String> getBuildParameters()

The readonly map of build step parameters. Build step parameters consist of shared parameters and parameters visible to this particular step only. Use Constants.SYSTEM_PREFIX for system properties and Constants.ENV_PREFIX for environment variables. Parameters without these prefixes are treated as configuration parameters.

Returns:

readonly map of build step parameters

Since:

6.0

addBuildParameter

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

Adds build parameter to this build step. This parameter will be visible for this build step only. Use Constants.SYSTEM_PREFIX for system properties, or Constants.ENV_PREFIX for environment variables, or parameter without prefix to add configuration parameter (since 7.1) Parameters without these prefixes are configuration parameters.

Parameters:

key - key

value - value

Since:

6.0, 7.1

addBuildParameters

void addBuildParameters(@NotNull
                        Map<String,String> parameters)

Same as addBuildParameter(String, String) but accepts map

Parameters:

parameters - build parameters to add

Since:

8.0

isEnabled

boolean isEnabled()

Returns:

true if step is enabled, false otherwise

Since:

8.0