com.adaptc.mws.plugins.JobReport
|
Groovy Documentation | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Object
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.| Field Summary | |
|---|---|
private String |
account
The job's account. |
private String |
commandFile
The job's executable command file. |
private String |
commandLineArguments
The job's command line arguments. |
private Date |
completedDate
The date that the job completed. |
private Integer |
completionCode
The completion code of the job. |
private String |
customName
The user-specified name of the job. |
private Date |
deadlineDate
The latest date that the job should be completed. |
private Long |
duration
The requested duration that the job should run. |
private Long |
durationSuspended
The job's suspend duration. |
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 |
image
The required image for the job, this relates to the image name field in the MWS Image Catalog. |
private String |
initialWorkingDirectory
The job's initial working directory. |
private String |
name
The job's name, this should be lower-case but will automatically be converted if it is not in setName(String). |
private List |
nodesRequested
The job's requested node names. |
private List |
partitionAccessList
The job's partition access list. |
private String |
pluginId
The ID of the plugin which has generated the report. |
private Long |
precedence
The precedence of the plugin which has generated the report. |
private String |
qos
The job's QOS. |
private JobReportRequirementsList |
requirements
The job's requirements list. |
private String |
reservationRequested
The identifier of the reservation requested for the job. |
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 |
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 name)
Creates a new job report for specified job. |
|
| Method Summary | |
|---|---|
String
|
getAccount()
@see #account |
String
|
getCommandFile()
@see #commandFile |
String
|
getCommandLineArguments()
@see #commandLineArguments |
Date
|
getCompletedDate()
@see #completedDate |
Integer
|
getCompletionCode()
@see #completionCode |
String
|
getCustomName()
@see #customName |
Date
|
getDeadlineDate()
@see #deadlineDate |
Long
|
getDuration()
@see #duration |
Long
|
getDurationSuspended()
@see #durationSuspended |
Date
|
getEarliestStartDate()
@see #earliestStartDate |
Map
|
getEnvironmentVariables()
@see #environmentVariables |
String
|
getExtension()
@see #extension |
List
|
getFlags()
@see #flags |
String
|
getGroup()
@see #group |
String
|
getImage()
@see #image |
String
|
getInitialWorkingDirectory()
@see #initialWorkingDirectory |
String
|
getName()
@see #name |
List
|
getNodesRequested()
@see #nodesRequested |
List
|
getPartitionAccessList()
@see #partitionAccessList |
String
|
getPluginId()
@see #pluginId |
Long
|
getPrecedence()
@see #precedence |
String
|
getQos()
@see #qos |
JobReportRequirementsList
|
getRequirements()
Retrieves the job requirements. |
String
|
getReservationRequested()
@see #reservationRequested |
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
|
getSystemPriority()
@see #systemPriority |
Date
|
getTimestamp()
Retrieves the set timestamp for the report. |
String
|
getUser()
@see #user |
void
|
setAccount(String account)
@see #account |
void
|
setCommandFile(String commandFile)
@see #commandFile |
void
|
setCommandLineArguments(String commandLineArguments)
@see #commandLineArguments |
void
|
setCompletedDate(Date completedDate)
@see #completedDate |
void
|
setCompletedDate(String completionDate)
@see #completedDate |
void
|
setCompletionCode(Integer completionCode)
@see #completionCode |
void
|
setCustomName(String customName)
@see #customName |
void
|
setDeadlineDate(Date deadlineDate)
@see #deadlineDate |
void
|
setDeadlineDate(String latestCompletedDateRequested)
@see #deadlineDate |
void
|
setDuration(Long duration)
@see #duration |
void
|
setDurationSuspended(Long durationSuspended)
@see #durationSuspended |
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
|
setImage(String image)
@see #image |
void
|
setInitialWorkingDirectory(String initialWorkingDirectory)
@see #initialWorkingDirectory |
void
|
setName(String name)
Sets the unique identifier for the job. |
void
|
setNodesRequested(List nodesRequested)
@see #nodesRequested |
void
|
setPartitionAccessList(List partitionAccessList)
@see #partitionAccessList |
void
|
setPluginId(String pluginId)
Sets the ID of the plugin which has generated the report. |
void
|
setPrecedence(Long precedence)
Sets the precedence, corresponding to the precedence of the plugin which has generated the report. |
void
|
setQos(String qos)
@see #qos |
void
|
setRequirements(JobReportRequirementsList requirements)
@see #requirements |
void
|
setReservationRequested(String reservationRequested)
@see #reservationRequested |
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
|
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 |
|---|
private String account
private String commandFile
private String commandLineArguments
private Date completedDate
private Integer completionCode
private String customName
private Date deadlineDate
private Long duration
private Long durationSuspended
private Date earliestStartDate
private Map environmentVariables
private String extension
private List flags
private String group
private String image
private String initialWorkingDirectory
private String name
private List nodesRequested
private List partitionAccessList
private String pluginId
private Long precedence
private String qos
private JobReportRequirementsList requirements
private String reservationRequested
private String standardErrorFilePath
private String standardInputFilePath
private String standardOutputFilePath
private Date startDate
private JobReportState state
private Date submitDate
private Long systemPriority
private Date timestamp
private String user
| Constructor Detail |
|---|
public JobReport()
public JobReport(String name)
name - See setName
| Method Detail |
|---|
public String getAccount()
public String getCommandFile()
public String getCommandLineArguments()
public Date getCompletedDate()
public Integer getCompletionCode()
public String getCustomName()
public Date getDeadlineDate()
public Long getDuration()
public Long getDurationSuspended()
public Date getEarliestStartDate()
public Map getEnvironmentVariables()
public String getExtension()
public List getFlags()
public String getGroup()
public String getImage()
public String getInitialWorkingDirectory()
public String getName()
public List getNodesRequested()
public List getPartitionAccessList()
public String getPluginId()
public Long getPrecedence()
public String getQos()
public JobReportRequirementsList getRequirements()
public String getReservationRequested()
public String getStandardErrorFilePath()
public String getStandardInputFilePath()
public String getStandardOutputFilePath()
public Date getStartDate()
public JobReportState getState()
public Date getSubmitDate()
public Long getSystemPriority()
public Date getTimestamp()
public String getUser()
public void setAccount(String account)
public void setCommandFile(String commandFile)
public void setCommandLineArguments(String commandLineArguments)
public void setCompletedDate(Date completedDate)
public void setCompletedDate(String completionDate)
public void setCompletionCode(Integer completionCode)
public void setCustomName(String customName)
public void setDeadlineDate(Date deadlineDate)
public void setDeadlineDate(String latestCompletedDateRequested)
public void setDuration(Long duration)
public void setDurationSuspended(Long durationSuspended)
public void setEarliestStartDate(Date earliestStartDate)
public void setEarliestStartDate(String earliestStartDate)
public void setEnvironmentVariables(Map environmentVariables)
public void setExtension(String extension)
public void setFlags(List flags)
public void setGroup(String group)
public void setImage(String image)
public void setInitialWorkingDirectory(String initialWorkingDirectory)
public void setName(String name)
public void setNodesRequested(List nodesRequested)
public void setPartitionAccessList(List partitionAccessList)
public void setPluginId(String pluginId)
public void setPrecedence(Long precedence)
public void setQos(String qos)
public void setRequirements(JobReportRequirementsList requirements)
public void setReservationRequested(String reservationRequested)
public void setStandardErrorFilePath(String standardErrorFilePath)
public void setStandardInputFilePath(String standardInputFilePath)
public void setStandardOutputFilePath(String standardOutputFilePath)
public void setStartDate(Date startDate)
public void setStartDate(String startDate)
public void setState(JobReportState state)
public void setState(String state)
public void setSubmitDate(Date submitDate)
public void setSubmitDate(String submitDate)
public void setSystemPriority(Long systemPriority)
public void setTimestamp(Date timestamp)
public void setTimestamp(String timestamp)
public void setUser(String user)
Groovy Documentation