Interface Schedule

interface Schedule {
    branchFilters?: string[];
    daysToBuild?: ScheduleDays;
    scheduleJobId?: string;
    scheduleOnlyWithChanges?: boolean;
    startHours?: number;
    startMinutes?: number;
    timeZoneId?: string;
}

Properties

branchFilters? daysToBuild? scheduleJobId? scheduleOnlyWithChanges? startHours? startMinutes? timeZoneId?

Properties

OptionalbranchFilters

branchFilters?: string[]

OptionaldaysToBuild

daysToBuild?: ScheduleDays

Days for a build (flags enum for days of the week)

OptionalscheduleJobId

scheduleJobId?: string

The Job Id of the Scheduled job that will queue the scheduled build. Since a single trigger can have multiple schedules and we want a single job to process a single schedule (since each schedule has a list of branches to build), the schedule itself needs to define the Job Id. This value will be filled in when a definition is added or updated. The UI does not provide it or use it.

OptionalscheduleOnlyWithChanges

scheduleOnlyWithChanges?: boolean

Flag to determine if this schedule should only build if the associated source has been changed.

OptionalstartHours

startHours?: number

Local timezone hour to start

OptionalstartMinutes

startMinutes?: number

Local timezone minute to start

OptionaltimeZoneId

timeZoneId?: string

Time zone of the build schedule (String representation of the time zone ID)

Settings

Member Visibility

On This Page

Properties