MAPREDUCE-5612. Add javadoc for TaskCompletionEvent.Status. Contributed by Chris Palmer.

(cherry picked from commit bfbf076b7d)
This commit is contained in:
Akira Ajisaka 2015-02-26 15:05:17 -08:00
parent 5dfb793b05
commit 8aa0c73294
3 changed files with 65 additions and 2 deletions

View File

@ -66,6 +66,9 @@ Release 2.7.0 - UNRELEASED
MAPREDUCE-6264. Remove httpclient dependency from hadoop-mapreduce-client. MAPREDUCE-6264. Remove httpclient dependency from hadoop-mapreduce-client.
(Brahma Reddy Battula via aajisaka) (Brahma Reddy Battula via aajisaka)
MAPREDUCE-5612. Add javadoc for TaskCompletionEvent.Status.
(Chris Palmer via aajisaka)
OPTIMIZATIONS OPTIMIZATIONS
MAPREDUCE-6169. MergeQueue should release reference to the current item MAPREDUCE-6169. MergeQueue should release reference to the current item

View File

@ -32,7 +32,37 @@ public class TaskCompletionEvent
extends org.apache.hadoop.mapreduce.TaskCompletionEvent { extends org.apache.hadoop.mapreduce.TaskCompletionEvent {
@InterfaceAudience.Public @InterfaceAudience.Public
@InterfaceStability.Stable @InterfaceStability.Stable
static public enum Status {FAILED, KILLED, SUCCEEDED, OBSOLETE, TIPFAILED}; /**
* Task Completion Statuses
*/
static public enum Status {
/**
* Task Event Attempt failed but there are attempts remaining.
*/
FAILED,
/**
* Task Event was killed.
*/
KILLED,
/**
* Task Event was successful.
*/
SUCCEEDED,
/**
* Used to Override a previously successful event status.
* Example: Map attempt runs and a SUCCEEDED event is sent. Later a task
* is retroactively failed due to excessive fetch failure during shuffle
* phase. When the retroactive attempt failure occurs, an OBSOLETE event is
* sent for the map attempt indicating the prior event is no longer valid.
*/
OBSOLETE,
/**
* Task Event attempt failed and no further attempts exist.
* reached MAX attempts. When a reducer receives a TIPFAILED event it
* gives up trying to shuffle data from that map task.
*/
TIPFAILED
}
public static final TaskCompletionEvent[] EMPTY_ARRAY = public static final TaskCompletionEvent[] EMPTY_ARRAY =
new TaskCompletionEvent[0]; new TaskCompletionEvent[0];

View File

@ -36,7 +36,37 @@ import org.apache.hadoop.io.WritableUtils;
public class TaskCompletionEvent implements Writable{ public class TaskCompletionEvent implements Writable{
@InterfaceAudience.Public @InterfaceAudience.Public
@InterfaceStability.Evolving @InterfaceStability.Evolving
static public enum Status {FAILED, KILLED, SUCCEEDED, OBSOLETE, TIPFAILED}; /**
* Task Completion Statuses
*/
static public enum Status {
/**
* Task Event Attempt failed but there are attempts remaining.
*/
FAILED,
/**
* Task Event was killed.
*/
KILLED,
/**
* Task Event was successful.
*/
SUCCEEDED,
/**
* Used to Override a previously successful event status.
* Example: Map attempt runs and a SUCCEEDED event is sent. Later a task
* is retroactively failed due to excessive fetch failure during shuffle
* phase. When the retroactive attempt failure occurs, an OBSOLETE event is
* sent for the map attempt indicating the prior event is no longer valid.
*/
OBSOLETE,
/**
* Task Event attempt failed and no further attempts exist.
* reached MAX attempts. When a reducer receives a TIPFAILED event it
* gives up trying to shuffle data from that map task.
*/
TIPFAILED
}
private int eventId; private int eventId;
private String taskTrackerHttp; private String taskTrackerHttp;