org.apache.flink.runtime.taskmanager

Class AbstractTaskResult

java.lang.Object

org.apache.flink.runtime.taskmanager.AbstractTaskResult

All Implemented Interfaces:

IOReadableWritable

Direct Known Subclasses:

TaskCancelResult, TaskKillResult, TaskSubmissionResult

public abstract class AbstractTaskResult
extends Object
implements IOReadableWritable

An AbstractTaskResult is used to report the results of a task related operation. It contains the ID of the corresponding task, a return code and a description. In case of an error the description includes an error message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTaskResult.ReturnCode

Constructor Summary

Constructors

Constructor and Description
AbstractTaskResult() Constructs an empty abstract task result.
AbstractTaskResult(ExecutionVertexID vertexID, AbstractTaskResult.ReturnCode returnCode) Constructs a new abstract task result.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description for this abstract task result.
AbstractTaskResult.ReturnCode	getReturnCode() Returns the return code of the result.
ExecutionVertexID	getVertexID() Returns the ID of the task this result belongs to.
void	read(DataInputView in)
void	setDescription(String description) Sets a description for this abstract task result.
void	write(DataOutputView out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTaskResult

public AbstractTaskResult(ExecutionVertexID vertexID,
                  AbstractTaskResult.ReturnCode returnCode)

Constructs a new abstract task result.

Parameters:

vertexID - the task ID this result belongs to

returnCode - the return code of the operation

AbstractTaskResult

public AbstractTaskResult()

Constructs an empty abstract task result.

Method Detail

setDescription

public void setDescription(String description)

Sets a description for this abstract task result.

Parameters:

description - the description to be set

getDescription

public String getDescription()

Returns the description for this abstract task result.

Returns:

the description for this abstract task result or null if no description has yet been set

getVertexID

public ExecutionVertexID getVertexID()

Returns the ID of the task this result belongs to.

Returns:

the ID of the task this result belongs to

getReturnCode

public AbstractTaskResult.ReturnCode getReturnCode()

Returns the return code of the result.

Returns:

the return code of the result

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Throws:

IOException