NAME

BuildForge::API::Build


SYNOPSIS

        my $Build = new BuildForge::API::Build
        my $build_list = $Build->Waiting();
        foreach my $bld (@$build_list) {
                print $bld->{'build_id'} . "--" . $bld->{'tag'} . "\n";
        }


DESCRIPTION

        This is available to use after a BuildForge::API object has been
instantiated. A Build object can be used to access the various build queues,
and to perform actions on running and historic builds.


METHODS

new({BuildParamsHashRef})

Create an object to access and modify builds and build queues.

build_id
The build id to associate this object with

Waiting()

Returns an array ref of hash refs of builds in the waiting queue.

Running()

Returns an array ref of hash refs of builds in the running queue.

Complete()

Returns an array ref of hash refs of builds in the completed queue.

Purge()

Queues the selected build to be purged. The Build object should be instantiated, or set, with a build_id.

Cancel()

Cancels the build. The Build object should be instantiated, or set, with a build_id. If the build is currently Waiting, the cancellation will not take effect until the build is Running.

Lock()

Locks the build. The Build object should be instantiated, or set, with a build_id.

UnLock()

Unlocks the build. The Build object should be instantiated, or set, with a build_id.

Locked()

Returns an array ref of hash refs of locked builds.

Sync()

Syncs the object with information from the console database. The Build object should be instantiated, or set, with a build_id.

ResultList()

Returns the step results for the build. Note that the step results from pass and fail chains are not included. The Build object should be instantiated, or set, with a build_id.

ResultLog({StepResult})

Returns the message log for the specified step result, or for the entire build if no valid step result is given. Note that the logs from pass and fail chains are not included. The step result, if specified, is a single entry from the array whose reference is returned by ResultList(). The Build object should be instantiated, or set, with a build_id.


AUTHOR

BuildForge, Inc.