Google Cloud Pub/Sub source 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 read from one Pub/Sub subscription

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

subscription

The name of the subscription from which to read 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

Advanced

subscription.max-messages-per-pull

The maximum number of pulled messages per pull request.

100

subscription.per-request-timeout-sec

The amount of time, in seconds, to wait before timing out.

15

subscription.retries

The maximum number of subscription-pull retry attempts before the connection job fails.

3

Messages are acknowledged to Pub/Sub approximately every 10 seconds. Best practice is to set the subscription’s acknowledgement deadline to be much larger, or else the messages might be processed multiple times.

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