Package uk.ac.manchester.spinnaker.spalloc.messages

Class JobDescription

java.lang.Object

uk.ac.manchester.spinnaker.spalloc.messages.JobDescription

public final class JobDescription
extends Object

A description of the state of a job.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobDescription.Builder	Builder for JobDescription.

Constructor Summary

Constructors

Constructor	Description
JobDescription(int jobID, String owner, Double startTime, State state, Boolean power, double keepAlive, String reason, String machine, List<Integer> args, Map<String,Object> kwargs, List<BoardCoordinates> boards, String keepAliveHost)

Method Summary

Modifier and Type	Method	Description
List<Integer>	getArgs()
List<BoardCoordinates>	getBoards()
int	getJobID()
double	getKeepAlive()
String	getKeepAliveHost()
Map<String,Object>	getKwargs()
String	getMachine()
String	getOwner()
Boolean	getPower()
String	getReason()
Double	getStartTime()
State	getState()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JobDescription

public JobDescription(int jobID, String owner, Double startTime, State state, Boolean power, double keepAlive, String reason, String machine, List<Integer> args, Map<String,Object> kwargs, List<BoardCoordinates> boards, String keepAliveHost)

Parameters:

jobID - The job's identifier

owner - The job's owner. This is not necessarily validated!

startTime - When the job started, in seconds from the epoch.

state - The job state.

power - Whether the job's allocated boards are powered on.

keepAlive - The job's maximum keepalive interval, in seconds.

reason - The reason why the job terminated.

machine - The name of the machine that the job is allocated to.

args - The positional arguments used to create the job.

kwargs - The keyword arguments used to create the job.

boards - The boards allocated to the job and their locations.

keepAliveHost - The host believed to be keeping the job alive.

Method Details

getState

public State getState()

Returns:

The job state.

getPower

public Boolean getPower()

Returns:

Whether the job's allocated boards are powered on.

getKeepAlive

public double getKeepAlive()

Returns:

The job's maximum keepalive interval, in seconds.

getReason

public String getReason()

Returns:

The reason why the job terminated.

getJobID

public int getJobID()

Returns:

The job's identifier.

getOwner

public String getOwner()

Returns:

The job's owner. This is not necessarily validated!

getStartTime

public Double getStartTime()

Returns:

When the job started, in seconds from the epoch.

getMachine

public String getMachine()

Returns:

The name of the machine that the job is allocated to.

getArgs

public List<Integer> getArgs()

Returns:

The positional arguments used to create the job.

getKwargs

public Map<String,Object> getKwargs()

Returns:

The keyword arguments used to create the job.

getBoards

public List<BoardCoordinates> getBoards()

Returns:

The boards allocated to the job and their locations.

getKeepAliveHost

public String getKeepAliveHost()

Returns:

The host believed to be keeping the job alive.

toString

public String toString()

Overrides:

toString in class Object