org.apache.flink.runtime.profiling.types

Class OutputGateProfilingEvent

java.lang.Object

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

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

org.apache.flink.runtime.profiling.types.VertexProfilingEvent

org.apache.flink.runtime.profiling.types.OutputGateProfilingEvent

All Implemented Interfaces:

IOReadableWritable, ManagementEvent

public final class OutputGateProfilingEvent
extends VertexProfilingEvent

Output gate profiling events are a special subclass of vertex profiling events. They contain profiling information which refer to particular output gates of a task.

This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
OutputGateProfilingEvent() Default constructor for the serialization/deserialization process.
OutputGateProfilingEvent(int gateIndex, int channelCapacityExhausted, ManagementVertexID vertexID, int profilingInterval, JobID jobID, long timestamp, long profilingTimestamp) Constructs a new output gate profiling event.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getChannelCapacityExhausted() Returns the number of times the capacity of an attached output channel was exhausted during the given profiling interval.
int	getGateIndex() Returns the index of input gate.
int	hashCode()
void	read(DataInputView in)
void	write(DataOutputView out)

Methods inherited from class org.apache.flink.runtime.profiling.types.VertexProfilingEvent

getProfilingInterval, getVertexID

Methods inherited from class org.apache.flink.runtime.profiling.types.ProfilingEvent

getJobID, getProfilingTimestamp

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

OutputGateProfilingEvent

public OutputGateProfilingEvent(int gateIndex,
                        int channelCapacityExhausted,
                        ManagementVertexID vertexID,
                        int profilingInterval,
                        JobID jobID,
                        long timestamp,
                        long profilingTimestamp)

Constructs a new output gate profiling event.

Parameters:

gateIndex - the index of the output gate at the corresponding management vertex

channelCapacityExhausted - indicates how often the output gate had exhausted one of its channels capacity during the last time period

vertexID - the ID of the management vertex this event refers to

profilingInterval - the interval of time this profiling event covers

jobID - the ID of the job this event refers to

timestamp - the time stamp of the event

profilingTimestamp - the time stamp of the profiling data

OutputGateProfilingEvent

public OutputGateProfilingEvent()

Default constructor for the serialization/deserialization process. Should not be called for other purposes.

Method Detail

getGateIndex

public int getGateIndex()

Returns the index of input gate.

Returns:

the index of the input gate

getChannelCapacityExhausted

public int getChannelCapacityExhausted()

Returns the number of times the capacity of an attached output channel was exhausted during the given profiling interval.

Returns:

the number of times a channel reached its capacity limit

read

public void read(DataInputView in)
          throws IOException

Specified by:

read in interface IOReadableWritable

Overrides:

read in class VertexProfilingEvent

Throws:

IOException

write

public void write(DataOutputView out)
           throws IOException

Specified by:

write in interface IOReadableWritable

Overrides:

write in class VertexProfilingEvent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class VertexProfilingEvent

hashCode

public int hashCode()

Overrides:

hashCode in class ProfilingEvent