Package com.atlassian.bamboo.specs.builders.trigger

Class ScheduledDeploymentTrigger

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.trigger.Trigger<ScheduledDeploymentTrigger,ScheduledTriggerProperties>

com.atlassian.bamboo.specs.builders.trigger.ScheduledDeploymentTrigger

public class ScheduledDeploymentTrigger
extends Trigger<ScheduledDeploymentTrigger,ScheduledTriggerProperties>

Represents a Scheduled trigger for deployment environments.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.trigger.Trigger

conditions, description, name, triggerEnabled

Constructor Summary

Constructors

Constructor	Description
ScheduledDeploymentTrigger()	Creates trigger which will schedule a build basing on a cron expression.

Method Summary

Modifier and Type	Method	Description
ScheduledDeploymentTrigger	artifactBranch(@Nullable java.lang.String artifactBranch)	Branch to provide artifacts for this deployment.
protected ScheduledTriggerProperties	build()
ScheduledDeploymentTrigger	cronExpression(@NotNull java.lang.String cronExpression)	Schedules deployment execution according to the cron expression.
ScheduledDeploymentTrigger	scheduleEvery(int every, @NotNull java.util.concurrent.TimeUnit at)	Schedules deployment execution every TimeUnit.SECONDS, TimeUnit.MINUTES or TimeUnit.HOURS.
ScheduledDeploymentTrigger	scheduleMonthly(@NotNull java.time.LocalTime at, int dayOfMonth)	Schedules deployment execution to every month on specified day of month and time.
ScheduledDeploymentTrigger	scheduleOnceDaily(@NotNull java.time.LocalTime at)	Schedules deployment execution to every day at specified time.
ScheduledDeploymentTrigger	scheduleWeekly(@NotNull java.time.LocalTime at, @NotNull java.util.Collection<java.time.DayOfWeek> days)	Schedules deployment execution to every week on specified week days and time.
ScheduledDeploymentTrigger	scheduleWeekly(@NotNull java.time.LocalTime at, java.time.DayOfWeek... onDays)	Schedules deployment execution to every week on specified week days at specified time.
ScheduledDeploymentTrigger	skipIfLatestVersionAlreadyDeployed(boolean skipIfLatestVersionAlreadyDeployed)	Should firing of the trigger be skipped if the latest version is already deployed.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.trigger.Trigger

conditions, description, enabled, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledDeploymentTrigger

public ScheduledDeploymentTrigger()
                           throws PropertiesValidationException

Creates trigger which will schedule a build basing on a cron expression.

Throws:

PropertiesValidationException

Method Detail

scheduleEvery

public ScheduledDeploymentTrigger scheduleEvery(int every,
                                                @NotNull
                                                @NotNull java.util.concurrent.TimeUnit at)

Schedules deployment execution every TimeUnit.SECONDS, TimeUnit.MINUTES or TimeUnit.HOURS.

scheduleOnceDaily

public ScheduledDeploymentTrigger scheduleOnceDaily(@NotNull
                                                    @NotNull java.time.LocalTime at)

Schedules deployment execution to every day at specified time.

scheduleWeekly

public ScheduledDeploymentTrigger scheduleWeekly(@NotNull
                                                 @NotNull java.time.LocalTime at,
                                                 java.time.DayOfWeek... onDays)

Schedules deployment execution to every week on specified week days at specified time.

scheduleWeekly

public ScheduledDeploymentTrigger scheduleWeekly(@NotNull
                                                 @NotNull java.time.LocalTime at,
                                                 @NotNull
                                                 @NotNull java.util.Collection<java.time.DayOfWeek> days)

Schedules deployment execution to every week on specified week days and time.

scheduleMonthly

public ScheduledDeploymentTrigger scheduleMonthly(@NotNull
                                                  @NotNull java.time.LocalTime at,
                                                  int dayOfMonth)

Schedules deployment execution to every month on specified day of month and time.

cronExpression

public ScheduledDeploymentTrigger cronExpression(@NotNull
                                                 @NotNull java.lang.String cronExpression)

Schedules deployment execution according to the cron expression. Default value is '0 0 0 ? * *'.

Cron expression won't be properly validated until sent out to Bamboo.

artifactBranch

public ScheduledDeploymentTrigger artifactBranch(@Nullable
                                                 @Nullable java.lang.String artifactBranch)

Branch to provide artifacts for this deployment.

Parameters:

artifactBranch - name of plan branch. If value is null artifacts will be taken from plan master branch.

skipIfLatestVersionAlreadyDeployed

public ScheduledDeploymentTrigger skipIfLatestVersionAlreadyDeployed(boolean skipIfLatestVersionAlreadyDeployed)

Should firing of the trigger be skipped if the latest version is already deployed.

build

protected ScheduledTriggerProperties build()

Specified by:

build in class Trigger<ScheduledDeploymentTrigger,ScheduledTriggerProperties>