jetbrains.buildServer.agent

Interface BuildRunnerSettings

public interface BuildRunnerSettings

Represents settings of a build runner on the agent. If build runner is composite (meta-runner), then it can have children. The settings are unresolved, i.e. parameter references are not evaluated.

Since:

2017.2

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getBuildParameters()
java.util.List<BuildRunnerSettings>	getChildren()
java.util.Map<java.lang.String,java.lang.String>	getConfigParameters()
java.lang.String	getId()
java.lang.String	getName()
BuildRunnerSettings	getParent()
java.util.Map<java.lang.String,java.lang.String>	getRunnerParameters()
java.lang.String	getRunType()
java.lang.String	getWorkingDirectory()
boolean	hasChildren()
boolean	isEnabled()

Method Detail

getRunType

@NotNull
java.lang.String getRunType()

Returns:

build step type

getName

@NotNull
java.lang.String getName()

Returns:

build step name defined by user

getId

@NotNull
java.lang.String getId()

Returns:

id of the build step

isEnabled

boolean isEnabled()

Returns:

true if this build step is enabled

hasChildren

boolean hasChildren()

Returns:

true if this build step has children (meta-runner)

getChildren

@NotNull
java.util.List<BuildRunnerSettings> getChildren()

Returns:

all sub-steps of this build step.

getParent

@Nullable
BuildRunnerSettings getParent()

Returns:

null if this step is a top level step, returns step settings if this step is a sub-step

getRunnerParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getRunnerParameters()

Returns:

build runner parameters (settings of a build step) (unresolved)

getBuildParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getBuildParameters()

Returns:

system properties and environment variables associated with this build runner (unresolved)

getConfigParameters

@NotNull
java.util.Map<java.lang.String,java.lang.String> getConfigParameters()

Returns:

configuration parameters associated with this build runner (unresolved)

getWorkingDirectory

@NotNull
java.lang.String getWorkingDirectory()

Returns:

working directory defined for this build step (unresolved)