Class SpallocProperties.AllocatorProperties

java.lang.Object

uk.ac.manchester.spinnaker.alloc.SpallocProperties.AllocatorProperties

Enclosing class:

SpallocProperties

public static class SpallocProperties.AllocatorProperties
extends Object

Configuration of the main resource allocation engine.

Author:

Donal Fellows

Constructor Summary

Constructors

Constructor	Description
AllocatorProperties(Duration period, int importanceSpan, SpallocProperties.PriorityScale priorityScale, int reportActionThreshold, String systemReportUser, String emergencyStopCommandCode)

Method Summary

Modifier and Type	Method	Description
@NotBlank String	getEmergencyStopCommandCode()
@Positive int	getImportanceSpan()	Maximum span of job importance that will be allocated at once.
@NotNull Duration	getPeriod()	Time between runs of the main allocation algorithm.
@NotNull @Valid SpallocProperties.PriorityScale	getPriorityScale()	Properties relating to job priority scaling.
@Positive int	getReportActionThreshold()
@NotNull String	getSystemReportUser()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AllocatorProperties

@ConstructorBinding
public AllocatorProperties(@DefaultValue("5s")
 Duration period,
 @DefaultValue("10000")
 int importanceSpan,
 @DefaultValue
 SpallocProperties.PriorityScale priorityScale,
 @DefaultValue("2")
 int reportActionThreshold,
 @DefaultValue("")
 String systemReportUser,
 @DefaultValue
 String emergencyStopCommandCode)

Parameters:

period - Time between runs of the main allocation algorithm.

importanceSpan - Maximum span of job importance that will be allocated at once. Priority is the rate at which importance is accrued.

priorityScale - Properties relating to job priority scaling.

reportActionThreshold - Number of reports of board problems at which the board is taken out of service.

systemReportUser - Name of user that system-generated reports are done by.

emergencyStopCommandCode - Command code to accept for an emergency stop.

Method Details

getPeriod

@NotNull
public @NotNull Duration getPeriod()

Time between runs of the main allocation algorithm.

Returns:

Time between runs of the main allocation algorithm.

getImportanceSpan

@Positive
public @Positive int getImportanceSpan()

Maximum span of job importance that will be allocated at once. Priority is the rate at which importance is accrued.

Returns:

Maximum importance span for considered jobs for a particular run of the allocator algorithm.

getPriorityScale

@NotNull
@Valid
public @NotNull @Valid SpallocProperties.PriorityScale getPriorityScale()

Properties relating to job priority scaling.

Returns:

Properties relating to job priority scaling.

getReportActionThreshold

@Positive
public @Positive int getReportActionThreshold()

Returns:

Number of reports of board problems at which the board is taken out of service.

getSystemReportUser

@NotNull
public @NotNull String getSystemReportUser()

Returns:

Name of user that system-generated reports are done by.

getEmergencyStopCommandCode

@NotBlank
public @NotBlank String getEmergencyStopCommandCode()

Returns:

Command code to accept for an emergency stop.