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

Class TimestampedCollector<T>

java.lang.Object

org.apache.flink.streaming.api.operators.TimestampedCollector<T>

Type Parameters:

T - The type of the elements that can be emitted.

All Implemented Interfaces:

Output<T>, Collector<T>

@Internal
public final class TimestampedCollector<T>
extends Object
implements Output<T>

Wrapper around an Output for user functions that expect a Output. Before giving the TimestampedCollector to a user function you must set the timestamp that should be attached to emitted elements. Most operators would set the timestamp of the incoming StreamRecord here.

Constructor Summary

Constructors

Constructor	Description
TimestampedCollector(Output<StreamRecord<T>> output)	Creates a new TimestampedCollector that wraps the given Output.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the collector.
<X> void	collect(OutputTag<X> outputTag, StreamRecord<X> record)	Emits a record to the side output identified by the given OutputTag.
void	collect(T record)	Emits a record.
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)
void	eraseTimestamp()
void	setAbsoluteTimestamp(long timestamp)
void	setTimestamp(StreamRecord<?> timestampBase)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimestampedCollector

public TimestampedCollector(Output<StreamRecord<T>> output)

Creates a new TimestampedCollector that wraps the given Output.

Method Detail

collect

public void collect(T record)

Description copied from interface: Collector

Emits a record.

Specified by:

collect in interface Collector<T>

Parameters:

record - The record to collect.

setTimestamp

public void setTimestamp(StreamRecord<?> timestampBase)

setAbsoluteTimestamp

public void setAbsoluteTimestamp(long timestamp)

eraseTimestamp

public void eraseTimestamp()

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 Collector<T>

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<T>

emitWatermarkStatus

public void emitWatermarkStatus(WatermarkStatus watermarkStatus)

Specified by:

emitWatermarkStatus in interface Output<T>

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<T>

record - The record to collect.

emitLatencyMarker

public void emitLatencyMarker(LatencyMarker latencyMarker)

Specified by:

emitLatencyMarker in interface Output<T>

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<T>