Google Cloud Pub/Sub sink connector

Features

Connector name

gcp-pubsub

Delivery guarantee

At least once

Supported task sizes

S, M, L

Multiplex capability

A single instance of this connector can write to one Pub/Sub topic

Supported stream types

Append stream

Configuration properties

Property Description Required Default

Basic

project

The project name that the Pub/Sub resource is located in.

Yes

topic

The name of the topic to which to write messages.

Yes

service-key-json

The secret associated with your service account. This must be provided as a secret resource.

Yes

format

The format of the data in the stream.

Must be one of:

  • json

  • avro

  • raw

If the format is raw, the corresponding stream schema should have a single field with name value and type string.

Yes

Prerequisites

  • A GCP service account key that can be used for authentication. You can create and download the key by browsing to the Keys tab under the Service Account details in GCP IAM.

  • A GCP subscription with the Pull delivery type.

  • The following GCP roles assigned to the service account principal:

    GCP Resource Role 1 Role 2

    Subscription

    Pub/Sub Viewer

    Pub/Sub Subscriber

Connector starting state and offsets

A new sink connection will start reading from the Latest point in the source Decodable stream. This means that only data that’s written to the stream when the connection has started will be sent to the external system. You can override this when you start the connection to Earliest if you want to send all the existing data on the source stream to the target system, along with all new data that arrives on the stream.

When you restart a sink connection it will continue to read data from the point it most recently stored in the checkpoint before the connection stopped. You can also opt to discard the connection’s state and restart it afresh from Earliest or Latest as described above.

Learn more about starting state here.