NAME

BuildForge::API::Selector


SYNOPSIS

        my $Selector = new BuildForge::API::Selector({'name'=>"MySelector");
        $Selector->Create();


DESCRIPTION

    This class allows you to create and modify selectors for use with projects
and steps to select servers to use with them.


METHODS

new(SelectorParamsHashref)

Creates the selector object to allow creation and modification of selectors.

name
The name of the selector.

properties
The properties to associate with this selector. Each property should be a hashref as described in the AddProperty method below.

Sync()

Syncs this selectors properties with the data currently in the BuildForge console.

AddProperty(PropertyParamsHashref)

Add a property to this selector

property
The name of the property

value
The value for the named property

operator
Conditions to apply to the property, valid conditions are '>','<','=','>=','<='.

required
If this condition must be met to select a server, then set this value to 'Y'.

DeleteProperty(PropertyParamsHashref)

Deletes a property from this selector. The property hashref can contain as many or few of the following properties as desired.

property
The name of the property

value
The value for the named property

operator
Conditions to apply to the property, valid conditions are '>','<','=','>=','<='.

required
If this condition must be met to select a server, then set this value to 'Y'.

Create()

Creates the Selector for use with projects and steps.

Delete()

Deletes the property from the console. Note that this will fail if the Selector is in use by any project or step.


AUTHOR

BuildForge, Inc.