NAME

BuildForge::API::Schedule


SYNOPSIS

        my $Sched = new BuildForge::API::Schedule();
        $Sched->{'description'} = "API Scheduled Job";
        $Sched->{'project_id'} = $Project->{'project_id'};
        $Sched->Create();


DESCRIPTION

    This class is available to user after a BuildForge::API object has been
instantiated. It is used to add, and delete schedules in the BuildForge 
engine, also allowing a schedule to be reset, and reevaluated by the engine.


METHODS

new({ScheduleParamsHashRef})

Create an object to access, create or delete schedules in the BuildForge engine.

description
The description for this schedule.

project_id
The id of the project to run.

owner_id
The user id of the schedule owner

environment_id
The id of the environment to use for these builds

custom_environment
The modified env to use for these builds.

active
If the schedule should be active or not (1/0)

minute
The minute cron for this schedule

hour
The hour cron for this schedule

day_of_month
The day of month cron for this schedule

month
The month cron for this schedule

day_of_week
The day of week cron for this schedule

server
The server to use for these builds

class
(3.7 only) The class to run these builds as

Create()

Creates a new Build Schedule, requires the object variables 'description' and 'project_id' to be set.

Delete()

Deletes the Build Schedule, requires the object variable 'description' or 'schedule_id' to be set.

Reset()

Recalculates the next run-time for the Schedule. Requires the object variable 'description' or 'schedule_id' to be set.

Sync()

Syncs the Schedule object with information from the database. Requires the object variable 'description' or 'schedule_id' to be set.


AUTHOR

BuildForge, Inc.