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

Class ScheduledTrigger

java.lang.Object

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

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

com.atlassian.bamboo.specs.builders.trigger.ScheduledTrigger

public class ScheduledTrigger
extends com.atlassian.bamboo.specs.api.builders.trigger.Trigger<ScheduledTrigger,ScheduledTriggerProperties>

Represents a Scheduled trigger.

Field Summary

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

conditions, description, name, triggerEnabled

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ScheduledTriggerProperties	build()
ScheduledTrigger	cronExpression(@NotNull java.lang.String cronExpression)	Schedules build execution according to the cron expression.
ScheduledTrigger	scheduleEvery(int every, @NotNull java.util.concurrent.TimeUnit at)	Schedules build execution every TimeUnit.SECONDS, TimeUnit.MINUTES or TimeUnit.HOURS.
ScheduledTrigger	scheduleMonthly(@NotNull java.time.LocalTime at, int dayOfMonth)	Schedules build execution to every month on specified day of month and time.
ScheduledTrigger	scheduleOnceDaily(@NotNull java.time.LocalTime at)	Schedules build execution to every day at specified time.
ScheduledTrigger	scheduleWeekly(@NotNull java.time.LocalTime at, @NotNull java.util.Collection<java.time.DayOfWeek> days)	Schedules build execution to every week on specified week days and time.
ScheduledTrigger	scheduleWeekly(@NotNull java.time.LocalTime at, java.time.DayOfWeek... onDays)	Schedules build execution to every week on specified week days at specified time.

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

ScheduledTrigger

public ScheduledTrigger()
                 throws com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

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

Throws:

com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException

Method Detail

scheduleEvery

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

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

scheduleOnceDaily

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

Schedules build execution to every day at specified time.

scheduleWeekly

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

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

scheduleWeekly

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

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

scheduleMonthly

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

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

cronExpression

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

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

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

build

protected ScheduledTriggerProperties build()

Specified by:

build in class com.atlassian.bamboo.specs.api.builders.trigger.Trigger<ScheduledTrigger,ScheduledTriggerProperties>