Package com.atlassian.bamboo.plan.trigger

Interface PlanTrigger

All Superinterfaces:

BambooPluginModule

All Known Implementing Classes:

JIRAReleasePlanTrigger

@ExperimentalApi
public interface PlanTrigger
extends BambooPluginModule

When paired with a TriggerReason gives the implementer control over how the Plan is triggered.

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,String>	getVariablesForContinuedBuild(@NotNull TriggerReason triggerReason)	Return plugin specific variables for continued builds
@NotNull PlanTriggerResult	triggerPlan(@NotNull TriggerReason triggerReason, @NotNull PlanResultKey planResultKey, @NotNull Map<String,String> params, @NotNull Map<String,String> customVariables, @Nullable PlanVcsRevisionDataSet lastVcsRevisionKeys)
default @NotNull PlanTriggerResult	triggerPlan(@NotNull TriggerReason triggerReason, @NotNull PlanResultKey planResultKey, @NotNull Map<String,String> params, @NotNull Map<String,String> customVariables, @Nullable PlanVcsRevisionDataSet lastVcsRevisionKeys, PlanExecutionLaunchControl.ReleaseLocksActions releaseLocksActions)

Method Detail

triggerPlan

@NotNull
@NotNull PlanTriggerResult triggerPlan(@NotNull
                                       @NotNull TriggerReason triggerReason,
                                       @NotNull
                                       @NotNull PlanResultKey planResultKey,
                                       @NotNull
                                       @NotNull Map<String,String> params,
                                       @NotNull
                                       @NotNull Map<String,String> customVariables,
                                       @Nullable
                                       @Nullable PlanVcsRevisionDataSet lastVcsRevisionKeys)

triggerPlan

@NotNull
default @NotNull PlanTriggerResult triggerPlan(@NotNull
                                               @NotNull TriggerReason triggerReason,
                                               @NotNull
                                               @NotNull PlanResultKey planResultKey,
                                               @NotNull
                                               @NotNull Map<String,String> params,
                                               @NotNull
                                               @NotNull Map<String,String> customVariables,
                                               @Nullable
                                               @Nullable PlanVcsRevisionDataSet lastVcsRevisionKeys,
                                               @NotNull
                                               PlanExecutionLaunchControl.ReleaseLocksActions releaseLocksActions)

getVariablesForContinuedBuild

@NotNull
@NotNull Map<String,String> getVariablesForContinuedBuild(@NotNull
                                                                @NotNull TriggerReason triggerReason)

Return plugin specific variables for continued builds

Returns: