Groovy Documentation

com.ace.mws.plugins
[Java] Class JobReport

java.lang.Object
  com.ace.mws.plugins.JobReport

public class JobReport
extends Object

A job report consists of values for all of the known, changed properties for a specific job resource. This typically represents changes in a specific time period (ie between the last poll and the current poll), but can also represent all known information concerning a resource (ie the first time poll is run).

For more information on reporting resources, see the Plugin Reporting section in the MWS documentation.

Authors:
bsaville


Field Summary
private String account

The job's account.

private List allocatedNodeIds

The actual identifiers for the nodes allocated to the job.

private String commandFile

The job's executable command file.

private String commandLineArguments

The job's command line arguments.

private Integer completionCode

The completion code of the job.

private Date completionDate

The date that the job completed.

private Long durationRequested

The requested duration that the job should run.

private Date earliestStartDate

The job's earliest start date.

private Map environmentVariables

The job's environment variables.

private String extension

The job's RM extension string.

private List flags

The job's flags.

private String group

The job's group.

private String id

The unique identifier for the job, this should be lower-case but will automatically be converted if it is not in setId(String).

private String initialWorkingDirectory

The job's initial working directory.

private Date latestCompletedDateRequested

The latest date that the job should be completed.

private String name

The job's name.

private List partitionAccessList

The job's partition access list.

private String pluginId

The ID of the plugin which has generated the report.

private String qos

The job's QOS.

private String requiredImage

The required image for the job, this relates to the image name field in the MWS Image Catalog.

private List requiredNodeIds

The job's required node's identifiers.

private JobReportRequirementsList requirements

The job's requirements list.

private String reservationRequestedId

The identifier of the reservation requested for the job.

private ReportResourceMap resources

The job's resources information.

private String standardErrorFilePath

The job's standard error file path.

private String standardInputFilePath

The job's standard input file path.

private String standardOutputFilePath

The job's standard output file path.

private Date startDate

The job's actual start date.

private JobReportState state

The job's current state.

private Date submitDate

The date at which the job was submitted.

private Long suspendDuration

The job's suspend duration.

private Long systemPriority

The job's system priority.

private Date timestamp

The date that the report was made or for which the report is current.

private String user

The job's user.

 
Constructor Summary
JobReport()

Creates a new, empty job report.

JobReport(String id)

Creates a new job report for specified job.

 
Method Summary
String getAccount()

@see #account

List getAllocatedNodeIds()

@see #allocatedNodeIds

String getCommandFile()

@see #commandFile

String getCommandLineArguments()

@see #commandLineArguments

Integer getCompletionCode()

@see #completionCode

Date getCompletionDate()

@see #completionDate

Long getDurationRequested()

@see #durationRequested

Date getEarliestStartDate()

@see #earliestStartDate

Map getEnvironmentVariables()

@see #environmentVariables

String getExtension()

@see #extension

List getFlags()

@see #flags

String getGroup()

@see #group

String getId()

@see #id

String getInitialWorkingDirectory()

@see #initialWorkingDirectory

Date getLatestCompletedDateRequested()

@see #latestCompletedDateRequested

String getName()

@see #name

List getPartitionAccessList()

@see #partitionAccessList

String getPluginId()

@see #pluginId

String getQos()

@see #qos

String getRequiredImage()

@see #requiredImage

List getRequiredNodeIds()

@see #requiredNodeIds

JobReportRequirementsList getRequirements()

Retrieves the job requirements.

String getReservationRequestedId()

@see #reservationRequestedId

ReportResourceMap getResources()

@see #resources

String getStandardErrorFilePath()

@see #standardErrorFilePath

String getStandardInputFilePath()

@see #standardInputFilePath

String getStandardOutputFilePath()

@see #standardOutputFilePath

Date getStartDate()

@see #startDate

JobReportState getState()

@see #state

Date getSubmitDate()

@see #submitDate

Long getSuspendDuration()

@see #suspendDuration

Long getSystemPriority()

@see #systemPriority

Date getTimestamp()

Retrieves the set timestamp for the report.

String getUser()

@see #user

void setAccount(String account)

@see #account

void setAllocatedNodeIds(List allocatedNodeIds)

@see #allocatedNodeIds

void setCommandFile(String commandFile)

@see #commandFile

void setCommandLineArguments(String commandLineArguments)

@see #commandLineArguments

void setCompletionCode(Integer completionCode)

@see #completionCode

void setCompletionDate(Date completionDate)

@see #completionDate

void setCompletionDate(String completionDate)

@see #completionDate

void setDurationRequested(Long durationRequested)

@see #durationRequested

void setEarliestStartDate(Date earliestStartDate)

@see #earliestStartDate

void setEarliestStartDate(String earliestStartDate)

@see #earliestStartDate

void setEnvironmentVariables(Map environmentVariables)

@see #environmentVariables

void setExtension(String extension)

@see #extension

void setFlags(List flags)

@see #flags

void setGroup(String group)

@see #group

void setId(String id)

Sets the unique identifier for the job.

void setInitialWorkingDirectory(String initialWorkingDirectory)

@see #initialWorkingDirectory

void setLatestCompletedDateRequested(Date latestCompletedDateRequested)

@see #latestCompletedDateRequested

void setLatestCompletedDateRequested(String latestCompletedDateRequested)

@see #latestCompletedDateRequested

void setName(String name)

@see #name

void setPartitionAccessList(List partitionAccessList)

@see #partitionAccessList

void setPluginId(String pluginId)

Sets the ID of the plugin which has generated the report.

void setQos(String qos)

@see #qos

void setRequiredImage(String requiredImage)

@see #requiredImage

void setRequiredNodeIds(List requiredNodeIds)

@see #requiredNodeIds

void setRequirements(JobReportRequirementsList requirements)

@see #requirements

void setReservationRequestedId(String reservationRequestedId)

@see #reservationRequestedId

void setResources(ReportResourceMap resources)

@see #resources

void setStandardErrorFilePath(String standardErrorFilePath)

@see #standardErrorFilePath

void setStandardInputFilePath(String standardInputFilePath)

@see #standardInputFilePath

void setStandardOutputFilePath(String standardOutputFilePath)

@see #standardOutputFilePath

void setStartDate(Date startDate)

@see #startDate

void setStartDate(String startDate)

@see #startDate

void setState(JobReportState state)

@see #state

void setState(String state)

Calls JobReportState.parse to set the state field.

void setSubmitDate(Date submitDate)

@see #submitDate

void setSubmitDate(String submitDate)

@see #submitDate

void setSuspendDuration(Long suspendDuration)

@see #suspendDuration

void setSystemPriority(Long systemPriority)

@see #systemPriority

void setTimestamp(Date timestamp)

@see #timestamp

void setTimestamp(String timestamp)

@see #timestamp

void setUser(String user)

@see #user

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

account

private String account
The job's account.


allocatedNodeIds

private List allocatedNodeIds
The actual identifiers for the nodes allocated to the job.


commandFile

private String commandFile
The job's executable command file.


commandLineArguments

private String commandLineArguments
The job's command line arguments.


completionCode

private Integer completionCode
The completion code of the job.


completionDate

private Date completionDate
The date that the job completed.


durationRequested

private Long durationRequested
The requested duration that the job should run.


earliestStartDate

private Date earliestStartDate
The job's earliest start date.


environmentVariables

private Map environmentVariables
The job's environment variables.


extension

private String extension
The job's RM extension string.


flags

private List flags
The job's flags.


group

private String group
The job's group.


id

private String id
The unique identifier for the job, this should be lower-case but will automatically be converted if it is not in setId(String).


initialWorkingDirectory

private String initialWorkingDirectory
The job's initial working directory.


latestCompletedDateRequested

private Date latestCompletedDateRequested
The latest date that the job should be completed.


name

private String name
The job's name.


partitionAccessList

private List partitionAccessList
The job's partition access list.


pluginId

private String pluginId
The ID of the plugin which has generated the report. NOTE: This is overridden by the RM services automatically and should not be set by the plugin.


qos

private String qos
The job's QOS.


requiredImage

private String requiredImage
The required image for the job, this relates to the image name field in the MWS Image Catalog.


requiredNodeIds

private List requiredNodeIds
The job's required node's identifiers.


requirements

private JobReportRequirementsList requirements
The job's requirements list. This may be treated as a single JobReportRequirement.


reservationRequestedId

private String reservationRequestedId
The identifier of the reservation requested for the job.


resources

private ReportResourceMap resources
The job's resources information. Note that no null checks are needed to act on the resources.


standardErrorFilePath

private String standardErrorFilePath
The job's standard error file path.


standardInputFilePath

private String standardInputFilePath
The job's standard input file path.


standardOutputFilePath

private String standardOutputFilePath
The job's standard output file path.


startDate

private Date startDate
The job's actual start date.


state

private JobReportState state
The job's current state.


submitDate

private Date submitDate
The date at which the job was submitted.


suspendDuration

private Long suspendDuration
The job's suspend duration.


systemPriority

private Long systemPriority
The job's system priority.


timestamp

private Date timestamp
The date that the report was made or for which the report is current. This will be set to the current date and time if not provided. This may also be set as a string which will use PluginConstants.STANDARD_DATE_FORMAT to parse into a date.


user

private String user
The job's user.


 
Constructor Detail

JobReport

public JobReport()
Creates a new, empty job report.


JobReport

public JobReport(String id)
Creates a new job report for specified job.
Parameters:
id - See setId


 
Method Detail

getAccount

public String getAccount()
See Also:
account


getAllocatedNodeIds

public List getAllocatedNodeIds()
See Also:
allocatedNodeIds


getCommandFile

public String getCommandFile()
See Also:
commandFile


getCommandLineArguments

public String getCommandLineArguments()
See Also:
commandLineArguments


getCompletionCode

public Integer getCompletionCode()
See Also:
completionCode


getCompletionDate

public Date getCompletionDate()
See Also:
completionDate


getDurationRequested

public Long getDurationRequested()
See Also:
durationRequested


getEarliestStartDate

public Date getEarliestStartDate()
See Also:
earliestStartDate


getEnvironmentVariables

public Map getEnvironmentVariables()
See Also:
environmentVariables


getExtension

public String getExtension()
See Also:
extension


getFlags

public List getFlags()
See Also:
flags


getGroup

public String getGroup()
See Also:
group


getId

public String getId()
See Also:
id


getInitialWorkingDirectory

public String getInitialWorkingDirectory()
See Also:
initialWorkingDirectory


getLatestCompletedDateRequested

public Date getLatestCompletedDateRequested()
See Also:
latestCompletedDateRequested


getName

public String getName()
See Also:
name


getPartitionAccessList

public List getPartitionAccessList()
See Also:
partitionAccessList


getPluginId

public String getPluginId()
See Also:
pluginId


getQos

public String getQos()
See Also:
qos


getRequiredImage

public String getRequiredImage()
See Also:
requiredImage


getRequiredNodeIds

public List getRequiredNodeIds()
See Also:
requiredNodeIds


getRequirements

public JobReportRequirementsList getRequirements()
Retrieves the job requirements. This list may be manipulated as a IJobReportRequirement itself.
See Also:
requirements


getReservationRequestedId

public String getReservationRequestedId()
See Also:
reservationRequestedId


getResources

public ReportResourceMap getResources()
See Also:
resources


getStandardErrorFilePath

public String getStandardErrorFilePath()
See Also:
standardErrorFilePath


getStandardInputFilePath

public String getStandardInputFilePath()
See Also:
standardInputFilePath


getStandardOutputFilePath

public String getStandardOutputFilePath()
See Also:
standardOutputFilePath


getStartDate

public Date getStartDate()
See Also:
startDate


getState

public JobReportState getState()
See Also:
state


getSubmitDate

public Date getSubmitDate()
See Also:
submitDate


getSuspendDuration

public Long getSuspendDuration()
See Also:
suspendDuration


getSystemPriority

public Long getSystemPriority()
See Also:
systemPriority


getTimestamp

public Date getTimestamp()
Retrieves the set timestamp for the report. NOTE: If no timestamp is provided by the plugin, the timestamp will be assigned a value of the current date and time.
See Also:
timestamp


getUser

public String getUser()
See Also:
user


setAccount

public void setAccount(String account)
See Also:
account


setAllocatedNodeIds

public void setAllocatedNodeIds(List allocatedNodeIds)
See Also:
allocatedNodeIds


setCommandFile

public void setCommandFile(String commandFile)
See Also:
commandFile


setCommandLineArguments

public void setCommandLineArguments(String commandLineArguments)
See Also:
commandLineArguments


setCompletionCode

public void setCompletionCode(Integer completionCode)
See Also:
completionCode


setCompletionDate

public void setCompletionDate(Date completionDate)
See Also:
completionDate


setCompletionDate

public void setCompletionDate(String completionDate)
See Also:
completionDate


setDurationRequested

public void setDurationRequested(Long durationRequested)
See Also:
durationRequested


setEarliestStartDate

public void setEarliestStartDate(Date earliestStartDate)
See Also:
earliestStartDate


setEarliestStartDate

public void setEarliestStartDate(String earliestStartDate)
See Also:
earliestStartDate


setEnvironmentVariables

public void setEnvironmentVariables(Map environmentVariables)
See Also:
environmentVariables


setExtension

public void setExtension(String extension)
See Also:
extension


setFlags

public void setFlags(List flags)
See Also:
flags


setGroup

public void setGroup(String group)
See Also:
group


setId

public void setId(String id)
Sets the unique identifier for the job. This automatically lower-cases the ID.
See Also:
id


setInitialWorkingDirectory

public void setInitialWorkingDirectory(String initialWorkingDirectory)
See Also:
initialWorkingDirectory


setLatestCompletedDateRequested

public void setLatestCompletedDateRequested(Date latestCompletedDateRequested)
See Also:
latestCompletedDateRequested


setLatestCompletedDateRequested

public void setLatestCompletedDateRequested(String latestCompletedDateRequested)
See Also:
latestCompletedDateRequested


setName

public void setName(String name)
See Also:
name


setPartitionAccessList

public void setPartitionAccessList(List partitionAccessList)
See Also:
partitionAccessList


setPluginId

public void setPluginId(String pluginId)
Sets the ID of the plugin which has generated the report. NOTE: This is overridden by the RM services automatically and should not be set by the plugin.
See Also:
pluginId


setQos

public void setQos(String qos)
See Also:
qos


setRequiredImage

public void setRequiredImage(String requiredImage)
See Also:
requiredImage


setRequiredNodeIds

public void setRequiredNodeIds(List requiredNodeIds)
See Also:
requiredNodeIds


setRequirements

public void setRequirements(JobReportRequirementsList requirements)
See Also:
requirements


setReservationRequestedId

public void setReservationRequestedId(String reservationRequestedId)
See Also:
reservationRequestedId


setResources

public void setResources(ReportResourceMap resources)
See Also:
resources


setStandardErrorFilePath

public void setStandardErrorFilePath(String standardErrorFilePath)
See Also:
standardErrorFilePath


setStandardInputFilePath

public void setStandardInputFilePath(String standardInputFilePath)
See Also:
standardInputFilePath


setStandardOutputFilePath

public void setStandardOutputFilePath(String standardOutputFilePath)
See Also:
standardOutputFilePath


setStartDate

public void setStartDate(Date startDate)
See Also:
startDate


setStartDate

public void setStartDate(String startDate)
See Also:
startDate


setState

public void setState(JobReportState state)
See Also:
state


setState

public void setState(String state)
Calls JobReportState.parse to set the state field.
See Also:
state


setSubmitDate

public void setSubmitDate(Date submitDate)
See Also:
submitDate


setSubmitDate

public void setSubmitDate(String submitDate)
See Also:
submitDate


setSuspendDuration

public void setSuspendDuration(Long suspendDuration)
See Also:
suspendDuration


setSystemPriority

public void setSystemPriority(Long systemPriority)
See Also:
systemPriority


setTimestamp

public void setTimestamp(Date timestamp)
See Also:
timestamp


setTimestamp

public void setTimestamp(String timestamp)
See Also:
timestamp


setUser

public void setUser(String user)
See Also:
user


 

Groovy Documentation