org.apache.hadoop.mapreduce
Class JobStatus

java.lang.Object
  extended by org.apache.hadoop.mapreduce.JobStatus
All Implemented Interfaces:
Cloneable, org.apache.hadoop.io.Writable
Direct Known Subclasses:
JobStatus

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class JobStatus
extends Object
implements org.apache.hadoop.io.Writable, Cloneable

Describes the current status of a job.


Nested Class Summary
static class JobStatus.State
          Current state of the job
 
Constructor Summary
JobStatus()
           
JobStatus(JobID jobid, float setupProgress, float mapProgress, float reduceProgress, float cleanupProgress, JobStatus.State runState, JobPriority jp, String user, String jobName, String jobFile, String trackingUrl)
          Create a job status object for a given jobid.
 
Method Summary
 Object clone()
           
 float getCleanupProgress()
           
 long getFinishTime()
          Get the finish time of the job.
 String getHistoryFile()
           
 Map<org.apache.hadoop.mapreduce.JobACL,org.apache.hadoop.security.authorize.AccessControlList> getJobACLs()
           
 String getJobFile()
          Get the configuration file for the job.
 JobID getJobID()
           
 String getJobName()
          Get the user-specified job name.
 float getMapProgress()
           
 JobPriority getPriority()
          Return the priority of the job
 float getReduceProgress()
           
 String getSchedulingInfo()
          Gets the Scheduling information associated to a particular Job.
 float getSetupProgress()
           
 long getStartTime()
           
 JobStatus.State getState()
           
 String getTrackingUrl()
          Get the link to the web-ui for details of the job.
 String getUsername()
           
 boolean isJobComplete()
          Returns true if the status is for a completed job.
 boolean isRetired()
          Check whether the job has retired.
 void readFields(DataInput in)
           
protected  void setCleanupProgress(float p)
          Sets the cleanup progress of this job
protected  void setFinishTime(long finishTime)
          Set the finish time of the job
protected  void setHistoryFile(String historyFile)
          Set the job history file url for a completed job
protected  void setJobACLs(Map<org.apache.hadoop.mapreduce.JobACL,org.apache.hadoop.security.authorize.AccessControlList> acls)
           
protected  void setMapProgress(float p)
          Sets the map progress of this job
protected  void setPriority(JobPriority jp)
          Set the priority of the job, defaulting to NORMAL.
protected  void setReduceProgress(float p)
          Sets the reduce progress of this Job
protected  void setRetired()
          Set the job retire flag to true.
protected  void setSchedulingInfo(String schedulingInfo)
          Used to set the scheduling information associated to a particular Job.
protected  void setSetupProgress(float p)
          Sets the setup progress of this job
protected  void setStartTime(long startTime)
          Set the start time of the job
protected  void setState(JobStatus.State state)
          Change the current run state of the job.
protected  void setTrackingUrl(String trackingUrl)
          Set the link to the web-ui for details of the job.
protected  void setUsername(String userName)
           
 String toString()
           
 void write(DataOutput out)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobStatus

public JobStatus()

JobStatus

public JobStatus(JobID jobid,
                 float setupProgress,
                 float mapProgress,
                 float reduceProgress,
                 float cleanupProgress,
                 JobStatus.State runState,
                 JobPriority jp,
                 String user,
                 String jobName,
                 String jobFile,
                 String trackingUrl)
Create a job status object for a given jobid.

Parameters:
jobid - The jobid of the job
setupProgress - The progress made on the setup
mapProgress - The progress made on the maps
reduceProgress - The progress made on the reduces
cleanupProgress - The progress made on the cleanup
runState - The current state of the job
jp - Priority of the job.
user - userid of the person who submitted the job.
jobName - user-specified job name.
jobFile - job configuration file.
trackingUrl - link to the web-ui for details of the job.
Method Detail

setMapProgress

protected void setMapProgress(float p)
Sets the map progress of this job

Parameters:
p - The value of map progress to set to

setCleanupProgress

protected void setCleanupProgress(float p)
Sets the cleanup progress of this job

Parameters:
p - The value of cleanup progress to set to

setSetupProgress

protected void setSetupProgress(float p)
Sets the setup progress of this job

Parameters:
p - The value of setup progress to set to

setReduceProgress

protected void setReduceProgress(float p)
Sets the reduce progress of this Job

Parameters:
p - The value of reduce progress to set to

setPriority

protected void setPriority(JobPriority jp)
Set the priority of the job, defaulting to NORMAL.

Parameters:
jp - new job priority

setFinishTime

protected void setFinishTime(long finishTime)
Set the finish time of the job

Parameters:
finishTime - The finishTime of the job

setHistoryFile

protected void setHistoryFile(String historyFile)
Set the job history file url for a completed job


setTrackingUrl

protected void setTrackingUrl(String trackingUrl)
Set the link to the web-ui for details of the job.


setRetired

protected void setRetired()
Set the job retire flag to true.


setState

protected void setState(JobStatus.State state)
Change the current run state of the job.


setStartTime

protected void setStartTime(long startTime)
Set the start time of the job

Parameters:
startTime - The startTime of the job

setUsername

protected void setUsername(String userName)
Parameters:
userName - The username of the job

setSchedulingInfo

protected void setSchedulingInfo(String schedulingInfo)
Used to set the scheduling information associated to a particular Job.

Parameters:
schedulingInfo - Scheduling information of the job

setJobACLs

protected void setJobACLs(Map<org.apache.hadoop.mapreduce.JobACL,org.apache.hadoop.security.authorize.AccessControlList> acls)

getMapProgress

public float getMapProgress()
Returns:
Percentage of progress in maps

getCleanupProgress

public float getCleanupProgress()
Returns:
Percentage of progress in cleanup

getSetupProgress

public float getSetupProgress()
Returns:
Percentage of progress in setup

getReduceProgress

public float getReduceProgress()
Returns:
Percentage of progress in reduce

getState

public JobStatus.State getState()
Returns:
running state of the job

getStartTime

public long getStartTime()
Returns:
start time of the job

clone

public Object clone()
Overrides:
clone in class Object

getJobID

public JobID getJobID()
Returns:
The jobid of the Job

getUsername

public String getUsername()
Returns:
the username of the job

getSchedulingInfo

public String getSchedulingInfo()
Gets the Scheduling information associated to a particular Job.

Returns:
the scheduling information of the job

getJobACLs

public Map<org.apache.hadoop.mapreduce.JobACL,org.apache.hadoop.security.authorize.AccessControlList> getJobACLs()

getPriority

public JobPriority getPriority()
Return the priority of the job

Returns:
job priority

isJobComplete

public boolean isJobComplete()
Returns true if the status is for a completed job.


write

public void write(DataOutput out)
           throws IOException
Specified by:
write in interface org.apache.hadoop.io.Writable
Throws:
IOException

readFields

public void readFields(DataInput in)
                throws IOException
Specified by:
readFields in interface org.apache.hadoop.io.Writable
Throws:
IOException

getJobName

public String getJobName()
Get the user-specified job name.


getJobFile

public String getJobFile()
Get the configuration file for the job.


getTrackingUrl

public String getTrackingUrl()
Get the link to the web-ui for details of the job.


getFinishTime

public long getFinishTime()
Get the finish time of the job.


isRetired

public boolean isRetired()
Check whether the job has retired.


getHistoryFile

public String getHistoryFile()
Returns:
the job history file name for a completed job. If job is not completed or history file not available then return null.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009 The Apache Software Foundation