org.apache.flink.runtime.event.job

Class JobEvent

java.lang.Object

org.apache.flink.runtime.event.job.AbstractEvent

org.apache.flink.runtime.event.job.JobEvent

All Implemented Interfaces:

Serializable, IOReadableWritable

public class JobEvent
extends AbstractEvent

A job event object is used by the job manager to inform a client about changes of the job's status.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobEvent() Constructs a new job event object.
JobEvent(long timestamp, JobStatus currentJobStatus, String optionalMessage) Constructs a new job event object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
JobStatus	getCurrentJobStatus() Returns the current status of the job.
String	getOptionalMessage() Returns the optional message that is possibly attached to this event.
int	hashCode()
void	read(DataInputView in)
String	toString()
void	write(DataOutputView out)

Methods inherited from class org.apache.flink.runtime.event.job.AbstractEvent

getSequenceNumber, getTimestamp, getTimestampString, timestampToString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobEvent

public JobEvent(long timestamp,
        JobStatus currentJobStatus,
        String optionalMessage)

Constructs a new job event object.

Parameters:

timestamp - the timestamp of the event

currentJobStatus - the current status of the job

optionalMessage - an optional message that shall be attached to this event, possibly null

JobEvent

public JobEvent()

Constructs a new job event object. This constructor is only required for the deserialization process and is not supposed to be called directly.

Method Detail

getCurrentJobStatus

public JobStatus getCurrentJobStatus()

Returns the current status of the job.

Returns:

the current status of the job

getOptionalMessage

public String getOptionalMessage()

Returns the optional message that is possibly attached to this event.

Returns:

the optional message, possibly null.

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Overrides:

read in class AbstractEvent

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Overrides:

write in class AbstractEvent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractEvent

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractEvent

toString

public String toString()

Overrides:

toString in class AbstractEvent