Consume

Consume messages from a Pub/Sub topic.

Requires a maxDuration or a maxRecords.

yaml
type: "io.kestra.plugin.gcp.pubsub.Consume"

yaml
id: gcp_pubsub_consume
namespace: company.team

tasks:
  - id: consume
    type: io.kestra.plugin.gcp.pubsub.Consume
    topic: topic-test
    maxRecords: 10
    projectId: {{ secret('GCP_PROJECT_ID') }}
    subscription: my-subscription

Dynamic NO

Default STRING

Possible Values

STRINGJSON

The serializer/deserializer to use.

Dynamic YES

The Pub/Sub subscription.

The Pub/Sub subscription. It will be created automatically if it didn't exist and 'autoCreateSubscription' is enabled.

Dynamic YES

The Pub/Sub topic

The Pub/Sub topic. It must be created before executing the task.

Dynamic NO

Default true

Whether the Pub/Sub subscription should be created if not exists.

Dynamic YES

The GCP service account to impersonate.

Dynamic NO

Format duration

Max duration in the Duration ISO format, after that the task will end.

Dynamic NO

Max number of records, when reached the task will end.

Dynamic YES

The GCP project ID.

SubType string

Dynamic YES

Default [ "https://www.googleapis.com/auth/cloud-platform" ]

The GCP scopes to be used.

Dynamic YES

The GCP service account.

Number of consumed rows.

Format uri

File URI containing consumed messages.

​Consume

Consume