Package org.apache.flink.streaming.api.operators

Class CountingOutput<OUT>

java.lang.Object

org.apache.flink.streaming.api.operators.CountingOutput<OUT>

All Implemented Interfaces:

Closeable, AutoCloseable, Output<StreamRecord<OUT>>, WatermarkGaugeExposingOutput<StreamRecord<OUT>>, Collector<StreamRecord<OUT>>

public class CountingOutput<OUT>
extends Object
implements WatermarkGaugeExposingOutput<StreamRecord<OUT>>

Wrapping Output that updates metrics on the number of emitted elements.

Constructor Summary

Constructors

Constructor	Description
CountingOutput(WatermarkGaugeExposingOutput<StreamRecord<OUT>> output, Counter numRecordsOut)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the collector.
void	collect(StreamRecord<OUT> record)	Emits a record.
<X> void	collect(OutputTag<X> outputTag, StreamRecord<X> record)	Emits a record to the side output identified by the given OutputTag.
void	emitLatencyMarker(LatencyMarker latencyMarker)
void	emitRecordAttributes(RecordAttributes recordAttributes)	Emits a RecordAttributes from an operator.
void	emitWatermark(Watermark mark)	Emits a Watermark from an operator.
void	emitWatermarkStatus(WatermarkStatus watermarkStatus)
Gauge<Long>	getWatermarkGauge()

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingOutput

public CountingOutput(WatermarkGaugeExposingOutput<StreamRecord<OUT>> output,
                      Counter numRecordsOut)

Method Detail

emitWatermark

public void emitWatermark(Watermark mark)

Description copied from interface: Output

Emits a Watermark from an operator. This watermark is broadcast to all downstream operators.

A watermark specifies that no element with a timestamp lower or equal to the watermark timestamp will be emitted in the future.

Specified by:

emitWatermark in interface Output<OUT>

emitWatermarkStatus

public void emitWatermarkStatus(WatermarkStatus watermarkStatus)

Specified by:

emitWatermarkStatus in interface Output<OUT>

emitLatencyMarker

public void emitLatencyMarker(LatencyMarker latencyMarker)

Specified by:

emitLatencyMarker in interface Output<OUT>

collect

public void collect(StreamRecord<OUT> record)

Description copied from interface: Collector

Emits a record.

Specified by:

collect in interface Collector<OUT>

Parameters:

record - The record to collect.

collect

public <X> void collect(OutputTag<X> outputTag,
                        StreamRecord<X> record)

Description copied from interface: Output

Emits a record to the side output identified by the given OutputTag.

Specified by:

collect in interface Output<OUT>

record - The record to collect.

close

public void close()

Description copied from interface: Collector

Closes the collector. If any data was buffered, that data will be flushed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Collector<OUT>

getWatermarkGauge

public Gauge<Long> getWatermarkGauge()

Specified by:

getWatermarkGauge in interface WatermarkGaugeExposingOutput<OUT>

emitRecordAttributes

public void emitRecordAttributes(RecordAttributes recordAttributes)

Description copied from interface: Output

Emits a RecordAttributes from an operator. This element is broadcast to all downstream operators.

Specified by:

emitRecordAttributes in interface Output<OUT>