PLUGINSPLUGIN-GCPTRIGGERSPUBSUBIO.KESTRA.PLUGIN.GCP.PUBSUB.TRIGGER

​Trigger

Trigger Trigger

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

Wait for messages in a Pub/Sub topic

Examples

yaml
id: "trigger"
type: "io.kestra.plugin.gcp.pubsub.Trigger"
topic: tes-topic
maxRecords: 10

Properties

topic

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

The Pub/Sub topic

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

autoCreateSubscription

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

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

interval

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

Interval between polling

The interval between 2 different test of schedule, this can avoid to overload the remote system with too many call. For most of trigger that depend on external system, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval value

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.

Outputs

count

  • Type: integer

Number of consumed rows.

uri

  • Type: string

File URI containing consumed messages.