org.apache.flink.connector.pulsar.sink.writer

Class PulsarWriter<IN>

java.lang.Object

org.apache.flink.connector.pulsar.sink.writer.PulsarWriter<IN>

Type Parameters:

IN - The type of the input elements.

All Implemented Interfaces:

AutoCloseable, SinkWriter<IN>, TwoPhaseCommittingSink.PrecommittingSinkWriter<IN,PulsarCommittable>

@Internal
public class PulsarWriter<IN>
extends Object
implements TwoPhaseCommittingSink.PrecommittingSinkWriter<IN,PulsarCommittable>

This class is responsible to write records in a Pulsar topic and to handle the different delivery DeliveryGuarantees.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.connector.sink2.SinkWriter

SinkWriter.Context

Constructor Summary

Constructors

Constructor and Description
PulsarWriter(SinkConfiguration sinkConfiguration, PulsarSerializationSchema<IN> serializationSchema, TopicMetadataListener metadataListener, TopicRouter<IN> topicRouter, MessageDelayer<IN> messageDelayer, Sink.InitContext initContext) Constructor creating a Pulsar writer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush(boolean endOfInput) Called on checkpoint or end of input so that the writer to flush all pending data for at-least-once.
Collection<PulsarCommittable>	prepareCommit() Prepares for a commit.
void	write(IN element, SinkWriter.Context context) Adds an element to the writer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.connector.sink2.SinkWriter

writeWatermark

Constructor Detail

PulsarWriter

public PulsarWriter(SinkConfiguration sinkConfiguration,
                    PulsarSerializationSchema<IN> serializationSchema,
                    TopicMetadataListener metadataListener,
                    TopicRouter<IN> topicRouter,
                    MessageDelayer<IN> messageDelayer,
                    Sink.InitContext initContext)

Constructor creating a Pulsar writer.

It will throw a RuntimeException if PulsarSerializationSchema#open(InitializationContext, PulsarSinkContext, SinkConfiguration) fails.

Parameters:

sinkConfiguration - The configuration to configure the Pulsar producer.

serializationSchema - Transform the incoming records into different message properties.

metadataListener - The listener for querying topic metadata.

topicRouter - Topic router to choose topic by incoming records.

initContext - Context to provide information about the runtime environment.

Method Detail

write

public void write(IN element,
                  SinkWriter.Context context)
           throws IOException,
                  InterruptedException

Description copied from interface: SinkWriter

Adds an element to the writer.

Specified by:

write in interface SinkWriter<IN>

Parameters:

element - The input record

context - The additional information about the input record

Throws:

IOException - if fail to add an element.

InterruptedException

flush

public void flush(boolean endOfInput)
           throws IOException,
                  InterruptedException

Description copied from interface: SinkWriter

Called on checkpoint or end of input so that the writer to flush all pending data for at-least-once.

Specified by:

flush in interface SinkWriter<IN>

Throws:

IOException

InterruptedException

prepareCommit

public Collection<PulsarCommittable> prepareCommit()

Description copied from interface: TwoPhaseCommittingSink.PrecommittingSinkWriter

Prepares for a commit.

This method will be called after SinkWriter.flush(boolean) and before StatefulSink.StatefulSinkWriter.snapshotState(long).

Specified by:

prepareCommit in interface TwoPhaseCommittingSink.PrecommittingSinkWriter<IN,PulsarCommittable>

Returns:

The data to commit as the second step of the two-phase commit protocol.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception