Package io.github.flink.gcp.connector.pubsub.sink

Class PubSubSink

java.lang.Object

io.github.flink.gcp.connector.pubsub.sink.PubSubSink

@Public
public final class PubSubSink
extends Object

Entry point for building a Pub/Sub sink.

The sink publishes records at-least-once through google-cloud-pubsub Publisher instances, resolving the destination topic per record (dynamic destinations) and flushing all outstanding publishes at every checkpoint barrier.

That at-least-once statement assumes the default FailureHandler.failJob() policy. Under a dropping policy configured through PubSubSinkBuilder.failedMessageHandler(FailureHandler), a completed checkpoint means every record up to the barrier was either published, skipped by the serializer, or handed to that handler.

Example:

 Sink<MyEvent> sink =
         PubSubSink.<MyEvent>builder()
                 .destinationResolver(
                         (e, ctx) -> TopicDestination.of("my-project", e.topicName()))
                 .serializer(
                         PubSubSerializationSchema.payload(new MyEventSerializationSchema()))
                 .build();
 

Method Summary

Modifier and Type	Method	Description
static <T> PubSubSinkBuilder<T>	builder()	Creates a new PubSubSinkBuilder.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static <T> PubSubSinkBuilder<T> builder()

Creates a new PubSubSinkBuilder.

Type Parameters:

T - type of the records written by the sink

Returns:

a new builder