Class BuildTriggerService
- java.lang.Object
-
- jetbrains.buildServer.buildTriggers.BuildTriggerService
-
- All Implemented Interfaces:
ServerExtension
,TeamCityExtension
public abstract class BuildTriggerService extends java.lang.Object implements ServerExtension
Represents build trigger service- Since:
- 5.1
-
-
Constructor Summary
Constructors Constructor Description BuildTriggerService()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.lang.String
describeTrigger(BuildTriggerDescriptor trigger)
Returns human readable description of the provided build trigger settingsabstract BuildTriggeringPolicy
getBuildTriggeringPolicy()
Returns policy used by build trigger to trigger builds.java.util.Map<java.lang.String,java.lang.String>
getDefaultTriggerProperties()
Returns default properties to use when trigger is createdabstract java.lang.String
getDisplayName()
Returns name of this trigger to show in UI.java.lang.String
getEditParametersUrl()
Returns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, seePluginDescriptor.getPluginResourcesPath(String)
abstract java.lang.String
getName()
Returns trigger namePropertiesProcessor
getTriggerPropertiesProcessor()
Returns processor for trigger properties.boolean
isMultipleTriggersPerBuildTypeAllowed()
Returns true if more than one trigger of this type can be added to the build configuration or template.boolean
supportsBuildCustomization()
Specifies whether this triggers allows users to set custom parameters for triggered builds.
-
-
-
Method Detail
-
getName
@NotNull public abstract java.lang.String getName()
Returns trigger name- Returns:
- trigger name
-
getDisplayName
@NotNull public abstract java.lang.String getDisplayName()
Returns name of this trigger to show in UI.- Returns:
- see above
-
describeTrigger
@NotNull public abstract java.lang.String describeTrigger(@NotNull BuildTriggerDescriptor trigger)
Returns human readable description of the provided build trigger settings- Parameters:
trigger
- trigger- Returns:
- see above
-
getTriggerPropertiesProcessor
@Nullable public PropertiesProcessor getTriggerPropertiesProcessor()
Returns processor for trigger properties. Properties processor performs validation function and is called when trigger is edited or created.- Returns:
- see above
-
getEditParametersUrl
@Nullable public java.lang.String getEditParametersUrl()
Returns path to jsp or to custom controller which will return trigger edit parameters page To resolve paths in plugin, seePluginDescriptor.getPluginResourcesPath(String)
- Returns:
- see above
- See Also:
PluginDescriptor
-
getDefaultTriggerProperties
@Nullable public java.util.Map<java.lang.String,java.lang.String> getDefaultTriggerProperties()
Returns default properties to use when trigger is created- Returns:
- see above
-
getBuildTriggeringPolicy
@NotNull public abstract BuildTriggeringPolicy getBuildTriggeringPolicy()
Returns policy used by build trigger to trigger builds.- Returns:
- build triggering policy
-
isMultipleTriggersPerBuildTypeAllowed
public boolean isMultipleTriggersPerBuildTypeAllowed()
Returns true if more than one trigger of this type can be added to the build configuration or template. By default returns false.- Returns:
- see above
-
supportsBuildCustomization
public boolean supportsBuildCustomization()
Specifies whether this triggers allows users to set custom parameters for triggered builds. If the returned value is true then thePolledBuildTrigger.triggerBuild(PolledTriggerContext)
should usePolledTriggerContext.createBuildCustomizer(jetbrains.buildServer.users.SUser)
to create triggered build promotions.- Since:
- 2021.1
-
-