Package jetbrains.buildServer.serverSide

Interface RestBuildTriggerExtension

All Superinterfaces:

ServerExtension, TeamCityExtension

public interface RestBuildTriggerExtension
extends ServerExtension

Extension point that allows to customize the triggering of builds via the /buildQueue REST endpoint.

Since:

2024.12

Method Summary

Modifier and Type	Method	Description
SUser	getTriggeringUser(SBuildType buildType, Map<String,Parameter> buildParameters)	Returns the user to use when creating the BuildCustomizer.
boolean	isApplicable(List<Parameter> buildParameters)	Determines if this extension should be applied to the requested build or not.

Method Detail

isApplicable

boolean isApplicable(@Nullable
                     List<Parameter> buildParameters)

Determines if this extension should be applied to the requested build or not.

Parameters:

buildParameters - parameters of the requested build

Returns:

true if applicable, otherwise false

getTriggeringUser

@Nullable
SUser getTriggeringUser(@NotNull
                        SBuildType buildType,
                        @Nullable
                        Map<String,Parameter> buildParameters)

Returns the user to use when creating the BuildCustomizer. This is an optional value.

Parameters:

buildType - the build configuration that will be used for the build customization

buildParameters - parameters of the requested build

Returns:

a user or null

Throws:

RuntimeException - if determining the user fails