org.apache.flink.runtime.profiling.types

Class ProfilingEvent

java.lang.Object

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

org.apache.flink.runtime.profiling.types.ProfilingEvent

All Implemented Interfaces:

IOReadableWritable, ManagementEvent

Direct Known Subclasses:

InstanceProfilingEvent, VertexProfilingEvent

public abstract class ProfilingEvent
extends AbstractEvent
implements ManagementEvent

A profiling event is a special type of event. It is intended to transport profiling data of a Nephele job to external components.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
ProfilingEvent() Default constructor for serialization/deserialization.
ProfilingEvent(JobID jobID, long timestamp, long profilingTimestamp) Constructs a new profiling event.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
JobID	getJobID() Returns the ID of the job this profiling information belongs to.
long	getProfilingTimestamp() Returns the timestamp of this profiling information.
int	hashCode()
void	read(DataInputView in)
void	write(DataOutputView out)

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

getSequenceNumber, getTimestamp, timestampToString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfilingEvent

public ProfilingEvent(JobID jobID,
              long timestamp,
              long profilingTimestamp)

Constructs a new profiling event.

Parameters:

jobID - the ID of the job this profiling events belongs to

timestamp - the time stamp of the event

profilingTimestamp - the time stamp of the profiling data

ProfilingEvent

public ProfilingEvent()

Default constructor for serialization/deserialization.

Method Detail

getJobID

public JobID getJobID()

Returns the ID of the job this profiling information belongs to.

Returns:

the ID of the job this profiling information belongs to

getProfilingTimestamp

public long getProfilingTimestamp()

Returns the timestamp of this profiling information. The timestamp denotes the time period in milliseconds between the creation of this profiling information and the start of the corresponding vertex's execution.

Returns:

the timestamp of this profiling information.

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