Consume Consume 

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

Consume messages from a Pub/Sub topic.

Required a maxDuration or a maxRecords.

# Examples

id: "consume"
type: "io.kestra.plugin.gcp.pubsub.Consume"
topic: topic-test
maxRecords: 10

# Properties

# autoCreateSubscription

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Whether the Pub/Sub subscription should be created if not exist

# maxDuration

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Format: duration

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

# maxRecords

  • Type: integer
  • Dynamic: ❌
  • Required: ❌

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

# projectId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The GCP project id

# scopes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: [https://www.googleapis.com/auth/cloud-platform]

The GCP scopes to used

# serviceAccount

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The GCP service account key

# subscription

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The Pub/Sub subscription

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

# topic

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The Pub/Sub topic

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

# Outputs

# count

  • Type: integer

Number of consumed rows.

# uri

  • Type: string

File URI containing consumed messages.

← Publish →

 Tweet  Share  Share