Job (scheduling 8.4.0 API)

java.lang.Object
- org.ow2.proactive.scheduler.common.task.CommonAttribute
- - org.ow2.proactive.scheduler.common.job.Job

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JobState, TaskFlowJob
```
@PublicAPI
public abstract class Job
extends CommonAttribute
```
Definition of a job for the user. You can create a job by using this class. Job will be used to set some properties, and give it the different tasks to run.
Here's a definition of the different parts of a job:
setName(String) will be used to identified the job.
setDescription(String) to set a short description of your job.
setPriority(JobPriority) to set the priority for the job, see JobPriority for more details.
CommonAttribute.setOnTaskError(OnTaskError) to set a predefined action when an exception occurred in at least one of the task.

Once the job created, you can submit it to the scheduler using the UserSchedulerInterface.

Since:

ProActive Scheduling 0.9

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description` Short description of this job
`protected String`	`globalSpace`
`protected String`	`inputSpace`
`static String`	`JOB_DDL`
`static String`	`JOB_EXEC_TIME`
`protected String`	`name` Name of the job
`protected String`	`outputSpace`
`protected JobPriority`	`priority` Job priority
`protected String`	`projectName` Project name for this job
`protected Map<String,JobVariable>`	`unresolvedVariables` A map to holds job descriptor variables with their values unresolved against other variables
`protected String`	`userSpace`
`protected Map<String,JobVariable>`	`variables` A map to holds job descriptor variables
`protected String`	`visualization` SVG Visualization rendering of this job

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute
GENERIC_INFO_START_AT_KEY, genericInformation, maxNumberOfExecution, onTaskError, restartTaskOnError, unresolvedGenericInformation

Constructor Summary

Constructors
Constructor and Description

Job()
ProActive Empty Constructor

Constructors
Constructor and Description
`Job()` ProActive Empty Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`display()`
`String`	`getDescription()` To get the description
`String`	`getGlobalSpace()`
`abstract JobId`	`getId()` To get the id
`String`	`getInputSpace()` Get the input Space
`String`	`getJobContent()`
`Optional<JobDeadline>`	`getJobDeadline()` Deadline can be as absolute or relative (from the job started time) Absolute deadline can be set as GI vairable `JOB_DDL` in ISO8601 date format without milliseconds, e.g.
`Optional<Duration>`	`getJobExpectedExecutionTime()`
`String`	`getName()` To get the name of the job.
`String`	`getOutputSpace()` Get the output Space
`JobPriority`	`getPriority()` To get the priority of the job.
`String`	`getProjectName()` Returns the project Name.
`abstract JobType`	`getType()` To get the type of this job
`Map<String,JobVariable>`	`getUnresolvedVariables()` Returns the unresolved variable map of this job.
`String`	`getUserSpace()`
`Map<String,JobVariable>`	`getVariables()` Returns the variable map of this job.
`Map<String,String>`	`getVariablesAsReplacementMap()` Returns a map containing the variable names and their values.
`String`	`getVisualization()` Get the job visualization rendering in SVG format
`void`	`setDescription(String description)` To set a short description for the job.
`void`	`setGlobalSpace(String globalSpace)` Set the global Space value to the given GLOBAL space string value
`void`	`setInputSpace(String inputSpace)` Set the input Space value to the given inputSpace value
`void`	`setJobContent(String jobContent)`
`void`	`setName(String name)` To set the name of the job.
`void`	`setOutputSpace(String outputSpace)` Set the output Space value to the given outputSpace value
`void`	`setPriority(JobPriority priority)` To set the priority of the job.
`void`	`setProjectName(String projectName)` Sets the project Name to the given projectName value.
`void`	`setUnresolvedVariables(Map<String,JobVariable> unresolvedVariables)` Sets the unresolved variable map for this job.
`void`	`setUserSpace(String userSpace)` Set the USER space value to the given USER space string value
`void`	`setVariables(Map<String,JobVariable> variables)` Sets the variable map for this job.
`void`	`setVisualization(String visualization)` Set the SVG code of the job visualization
`String`	`toString()`
`static void`	`verifyVariableMap(Map<String,? extends JobVariable> variables)`

Methods inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute
addGenericInformation, addGenericInformations, applyReplacementsOnGenericInformation, getGenericInformation, getMaxNumberOfExecution, getMaxNumberOfExecutionProperty, getOnTaskErrorProperty, getRestartTaskOnError, getRestartTaskOnErrorProperty, getUnresolvedGenericInformation, setGenericInformation, setMaxNumberOfExecution, setOnTaskError, setRestartTaskOnError, setUnresolvedGenericInformation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - JOB_DDL
```
public static final String JOB_DDL
```
    See Also:
    
    Constant Field Values
  - JOB_EXEC_TIME
```
public static final String JOB_EXEC_TIME
```
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
    Name of the job
  - description
```
protected String description
```
    Short description of this job
  - projectName
```
protected String projectName
```
    Project name for this job
  - priority
```
protected JobPriority priority
```
    Job priority
  - inputSpace
```
protected String inputSpace
```
  - outputSpace
```
protected String outputSpace
```
  - globalSpace
```
protected String globalSpace
```
  - userSpace
```
protected String userSpace
```
  - visualization
```
protected String visualization
```
    SVG Visualization rendering of this job
  - variables
```
protected Map<String,JobVariable> variables
```
    A map to holds job descriptor variables
  - unresolvedVariables
```
protected Map<String,JobVariable> unresolvedVariables
```
    A map to holds job descriptor variables with their values unresolved against other variables
- Constructor Detail
  - Job
```
public Job()
```
    ProActive Empty Constructor
- Method Detail
  - getType
```
public abstract JobType getType()
```
    To get the type of this job
    
    Returns:
    
    the type of this job
  - getId
```
public abstract JobId getId()
```
    To get the id
    
    Returns:
    
    the id
  - getDescription
```
public String getDescription()
```
    To get the description
    
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    To set a short description for the job.
    
    Parameters:
    
    description - the description to set.
  - getName
```
public String getName()
```
    To get the name of the job.
    
    Returns:
    
    the name of the job.
  - setName
```
public void setName(String name)
```
    To set the name of the job.
    
    Parameters:
    
    name - the name to set.
  - getPriority
```
public JobPriority getPriority()
```
    To get the priority of the job.
    
    Returns:
    
    the priority of the job.
  - setPriority
```
public void setPriority(JobPriority priority)
```
    To set the priority of the job. (Default is 'NORMAL')
    
    Parameters:
    
    priority - the priority to set.
  - getProjectName
```
public String getProjectName()
```
    Returns the project Name.
    
    Returns:
    
    the project Name.
  - setProjectName
```
public void setProjectName(String projectName)
```
    Sets the project Name to the given projectName value.
    
    Parameters:
    
    projectName - the project Name to set.
  - getInputSpace
```
public String getInputSpace()
```
    Get the input Space
    
    Returns:
    
    the input Space
  - setInputSpace
```
public void setInputSpace(String inputSpace)
```
    Set the input Space value to the given inputSpace value
    
    Parameters:
    
    inputSpace - the input Space to set
  - getOutputSpace
```
public String getOutputSpace()
```
    Get the output Space
    
    Returns:
    
    the output Space
  - setOutputSpace
```
public void setOutputSpace(String outputSpace)
```
    Set the output Space value to the given outputSpace value
    
    Parameters:
    
    outputSpace - the outputDataSpaceURL to set
  - getGlobalSpace
```
public String getGlobalSpace()
```
  - setGlobalSpace
```
public void setGlobalSpace(String globalSpace)
```
    Set the global Space value to the given GLOBAL space string value
    
    Parameters:
    
    globalSpace - the globalDataSpaceURL to set
  - getUserSpace
```
public String getUserSpace()
```
  - setUserSpace
```
public void setUserSpace(String userSpace)
```
    Set the USER space value to the given USER space string value
    
    Parameters:
    
    userSpace - the userDataSpaceURL to set
  - getVisualization
```
public String getVisualization()
```
    Get the job visualization rendering in SVG format
    
    Returns:
    
    Job visualization SVG code
  - setVisualization
```
public void setVisualization(String visualization)
```
    Set the SVG code of the job visualization
    
    Parameters:
    
    visualization - SVG code String
  - setVariables
```
public void setVariables(Map<String,JobVariable> variables)
```
    Sets the variable map for this job.
    
    Parameters:
    
    variables - the variables map
  - setUnresolvedVariables
```
public void setUnresolvedVariables(Map<String,JobVariable> unresolvedVariables)
```
    Sets the unresolved variable map for this job.
    
    Parameters:
    
    unresolvedVariables - the unresolved variables map
  - verifyVariableMap
```
public static void verifyVariableMap(Map<String,? extends JobVariable> variables)
```
  - getVariables
```
public Map<String,JobVariable> getVariables()
```
    Returns the variable map of this job.
    
    Returns:
    
    a variable map
  - getUnresolvedVariables
```
public Map<String,JobVariable> getUnresolvedVariables()
```
    Returns the unresolved variable map of this job.
    
    Returns:
    
    an unresolved variable map
  - getVariablesAsReplacementMap
```
public Map<String,String> getVariablesAsReplacementMap()
```
    Returns a map containing the variable names and their values.
    
    Returns:
    
    a variable map
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - display
```
public String display()
```
  - getJobDeadline
```
public Optional<JobDeadline> getJobDeadline()
```
    Deadline can be as absolute or relative (from the job started time) Absolute deadline can be set as GI vairable `JOB_DDL` in ISO8601 date format without milliseconds, e.g. 2018-08-14T08:40:30+02:00. Relative deadline can be set as GI vairable `JOB_DDL` in the following format +HH:MM:SS, e.g. `+02:30:00`, or as +MM:SS, e.g. `+15:30`, or as +SS, e.g. `+40`.
    
    Returns:
    
    job deadline if it exists
  - getJobExpectedExecutionTime
```
public Optional<Duration> getJobExpectedExecutionTime()
```
  - getJobContent
```
public String getJobContent()
```
  - setJobContent
```
public void setJobContent(String jobContent)
```

Class Job

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

Constructor Summary

Method Summary

Methods inherited from class org.ow2.proactive.scheduler.common.task.CommonAttribute

Methods inherited from class java.lang.Object

Field Detail

JOB_DDL

JOB_EXEC_TIME

name

description

projectName

priority

inputSpace

outputSpace

globalSpace

userSpace

visualization

variables

unresolvedVariables

Constructor Detail

Job

Method Detail

getType

getId

getDescription

setDescription

getName

setName

getPriority

setPriority

getProjectName

setProjectName

getInputSpace

setInputSpace

getOutputSpace

setOutputSpace

getGlobalSpace

setGlobalSpace

getUserSpace

setUserSpace

getVisualization

setVisualization

setVariables

setUnresolvedVariables

verifyVariableMap

getVariables

getUnresolvedVariables

getVariablesAsReplacementMap

toString

display

getJobDeadline

getJobExpectedExecutionTime

getJobContent

setJobContent