org.apache.flink.runtime.event.job

Class VertexEvent

java.lang.Object

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

org.apache.flink.runtime.event.job.VertexEvent

All Implemented Interfaces:

Serializable, IOReadableWritable

public class VertexEvent
extends AbstractEvent

Vertex events are transmitted from the job manager to the job client in order to inform the user about changes in terms of a tasks execution state.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VertexEvent() Constructs a new vertex event object.
VertexEvent(long timestamp, JobVertexID jobVertexID, String jobVertexName, int totalNumberOfSubtasks, int indexOfSubtask, ExecutionAttemptID executionAttemptId, ExecutionState currentExecutionState, String description) Constructs a new vertex event object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
ExecutionState	getCurrentExecutionState() Returns the current execution state of the subtask this event belongs to.
String	getDescription() Returns an optional description which may be attached to this event.
ExecutionAttemptID	getExecutionAttemptId()
int	getIndexOfSubtask() Returns the index of the subtask that this event belongs to.
JobVertexID	getJobVertexID() Returns the ID of the job vertex this event belongs to.
String	getJobVertexName() Returns the name of the job vertex this event belongs to.
int	getTotalNumberOfSubtasks() Returns the number of subtasks the corresponding vertex has been split into at runtime.
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

VertexEvent

public VertexEvent(long timestamp,
           JobVertexID jobVertexID,
           String jobVertexName,
           int totalNumberOfSubtasks,
           int indexOfSubtask,
           ExecutionAttemptID executionAttemptId,
           ExecutionState currentExecutionState,
           String description)

Constructs a new vertex event object.

Parameters:

timestamp - the timestamp of the event

jobVertexID - the ID of the job vertex this event belongs to

jobVertexName - the name of the job vertex this event belongs to

totalNumberOfSubtasks - the number of subtasks the corresponding vertex has been split into at runtime

indexOfSubtask - the index of the subtask that this event belongs to

currentExecutionState - the current execution state of the subtask this event belongs to

description - an optional description

VertexEvent

public VertexEvent()

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

Method Detail

getJobVertexID

public JobVertexID getJobVertexID()

Returns the ID of the job vertex this event belongs to.

Returns:

the ID of the job vertex this event belongs to

getJobVertexName

public String getJobVertexName()

Returns the name of the job vertex this event belongs to.

Returns:

the name of the job vertex, possibly null

getTotalNumberOfSubtasks

public int getTotalNumberOfSubtasks()

Returns the number of subtasks the corresponding vertex has been split into at runtime.

Returns:

the number of subtasks

getIndexOfSubtask

public int getIndexOfSubtask()

Returns the index of the subtask that this event belongs to.

Returns:

the index of the subtask

getCurrentExecutionState

public ExecutionState getCurrentExecutionState()

Returns the current execution state of the subtask this event belongs to.

Returns:

the current execution state of the subtask this event belongs to

getDescription

public String getDescription()

Returns an optional description which may be attached to this event.

Returns:

the description attached to this event, possibly null.

getExecutionAttemptId

public ExecutionAttemptID getExecutionAttemptId()

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