Consume

Consume messages from a Google Pub/Sub topic.

Requires a maxDuration or a maxRecords.

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

Examples

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

Properties

subscription *string

The Pub/Sub subscription.

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

topic *string

The Pub/Sub topic

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

autoCreateSubscription booleanstring

Default true

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

impersonatedServiceAccount string

The GCP service account to impersonate.

maxDuration string

Format duration

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

maxRecords integerstring

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

projectId string

The GCP project ID.

scopes array

SubType string

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

The GCP scopes to be used.

serdeType string

Default STRING

Possible Values

STRINGJSON

The serializer/deserializer to use.

serviceAccount string

The GCP service account.

Outputs

count integer

Number of consumed rows.

uri string

Format uri

File URI containing consumed messages.

​Consume

Consume