lp.buildmaster.interfaces.webservice.IBuilderSet : API documentation

Collections of builders.

IBuilderSet provides access to all Builders in the system, and also acts as a Factory to allow the creation of new Builders. Methods on this interface should deal with the set of Builders: methods that affect a single Builder should be on IBuilder.

Attribute	title	Title
Method	__iter__	Iterate over builders.
Method	__getitem__	Retrieve a builder by name
Method	getByName	Retrieve a builder by name
Method	count	Return the number of builders in the system.
Method	get	Return the IBuilder with the given builderid.
Method	getBuilders	Return all active configured builders.
Method	getBuildQueueSizes	Return the number of pending builds for each processor.
Method	getBuildersForQueue	Return all builders for given processor/virtualization setting.

Inherited from IBuilderSetAdmin:

Method

new

Create a new builder.

def __iter__():

Iterate over builders.

def __getitem__(name):

Retrieve a builder by name

@operation_parameters(TextLine(_('Builder name'), True))
@operation_returns_entry(IBuilder)
@export_read_operation()
def getByName(name):

Retrieve a builder by name

def count():

Return the number of builders in the system.

def get(builder_id):

Return the IBuilder with the given builderid.

@collection_default_content()
def getBuilders():

Return all active configured builders.

@export_read_operation()
@operation_for_version('devel')
def getBuildQueueSizes():

Return the number of pending builds for each processor.

Returns

a dict of tuples with the queue size and duration for each processor and virtualisation. For example:

{
    'virt': {
                '386': (1, datetime.timedelta(0, 60)),
                'amd64': (2, datetime.timedelta(0, 30)),
            },
    'nonvirt':...
}

The tuple contains the size of the queue, as an integer, and the sum of the jobs 'estimated_duration' in queue, as a timedelta or None for empty queues.

@operation_parameters(Reference(_('Processor'), True, IProcessor), Bool(_('Virtualized'), False, True))
@operation_returns_collection_of(IBuilder)
@export_read_operation()
@operation_for_version('devel')
def getBuildersForQueue(processor, virtualized):

Return all builders for given processor/virtualization setting.

l.b.i.w.IBuilderSet(IBuilderSetAdmin) : interface documentation