Package jetbrains.buildServer.serverSide.parameters

Interface BuildParametersProvider

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

AbstractBuildParametersProvider, AgentlessBuildParametersProvider, ApprovalBuildParametersProvider, AutoToolVersionParametersProvider, BuildBranchParameterProvider, BuildStepsParameterProvider, DefaultAgentParametersProvider, DefaultCheckoutDirParameterProvider, DefaultToolVersionParametersProvider, DependencyParametersProvider, PipelineParametersProvider, TimedBuildParametersProvider, ToolsParametersProvider, TriggeredByParametersProvider.TriggeredByParametersProviderImpl, UpperLimitRevisionParametersProvider, VCSSettingsBuildParametersProvider

@UserImplemented(adapterClass=AbstractBuildParametersProvider.class)
public interface BuildParametersProvider
extends ServerExtension

This extension allows to add additional parameters available for a build. These parameters can be system properties, environment variables or configuration parameters. Configuration parameters provided by this extension can then be used in references. System properties and environment variables will be passed to an agent and then to a build. It is recommended to extend AbstractBuildParametersProvider rather then implement this interface directly. To provide descriptions for the properties ParameterDescriptionProvider

Since:

5.0

Author:

Yegor.Yarko

See Also:

- allows to provide parameters visible to particular build steps, - allows to remove parameters from build step run parameters and from build parameters

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getParameters(SBuild build, boolean emulationMode)	Returns additional build parameters.
Collection<String>	getParametersAvailableOnAgent(SBuild build)	Returns collection of parameters (names) always available on the agent for the specified build.
default String	getPrefix()

Method Detail

getParameters

@NotNull
Map<String,String> getParameters(@NotNull
                                       SBuild build,
                                       boolean emulationMode)

Returns additional build parameters.

Parameters:

build - the build for which parameters should be added

emulationMode - if true then parameters are calculated in the emulation mode and provided build is a mock build. There are two cases when emulationMode is true:

• when a build for which we need to compute parameters is still in the queue
• when parameters should be calculated in a context of a build configuration when there is no build at all

in both of these cases a mock build will be passed to the getParameters() method, however in the first case the method BuildPromotionOwner.getBuildPromotion() will return an instance of a BuildPromotion which is in the queue (BuildPromotion.getQueuedBuild() will return a not null object), while in the second case a mock of BuildPromotion without any associated queued or started builds will be returned

Returns:

the map of the parameter name - parameter value pairs To provide descriptions for the properties ParameterDescriptionProvider

getParametersAvailableOnAgent

@NotNull
Collection<String> getParametersAvailableOnAgent(@NotNull
                                                 SBuild build)

Returns collection of parameters (names) always available on the agent for the specified build. Because concrete values of these parameters are not known on the server side only names are returned. This collection may not contain parameters returned by getParameters(jetbrains.buildServer.serverSide.SBuild,boolean). To provide descriptions for the properties ParameterDescriptionProvider

Parameters:

build - build

Returns:

see above

Since:

5.0

getPrefix

@NotNull
default String getPrefix()

Returns:

a common prefix used for all parameter names generated by this provider, returns empty string if there is no common prefix

Since:

2022.02