Subscribe

In this article

Overview

This Snap receives messages from a Google Pubsub topic using the subscription name. This uses the Synchronous Pull under-pull subscription method.
Note:
1. If the property Auto Acknowledge is not selected, the same data can be pulled, which means duplicate data will be there in the output.
2. The snap will pull the messages until the message count reaches.
3. Default batch size for each pull request is 1000. If the requested message count is less than 1000, then the batch size will be set to the message count before subscribing the messages.

Snap Type

Subscribe Snap is a Read-type Snap.

Prerequisites

  • None.

Limitations and Known Issues

None.

Account

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Google Pub Sub Service Account for information on setting up this type of account

Snap Views

Type

Description

Type

Description

Input 

This Snap has at most one document input view. Each document contains data in the form of json..

Output

This Snap has at most one document output view. Each document contains corresponding response in the form of json.

Error

This Snap has at most one document error view and produces zero or more documents in the view. Each document contains the corresponding error record if snap is not able to subscribe the messages from the google pubsub.

Snap Settings

Field Name

Description

Field Name

Description

Label

required

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Subscription Name

required

The messages will be pulled/received basing on the subscription name. The property is suggestable and will retrieve available subscription names based on the project id from the service account.

Default value: None

Message Count

optional

The number of messages to consume.

Default value: None

Timestamp

optional

Seeks to a specific time before subscribing the messages. The supported formats are : yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd

Default value: None

Example: 2019-07-10 or 2019-07-10T10:10:00

Snapshot

optional

Seeks to a specific snapshot before subscribing the messages. The property is suggestable and will retrieve available snapshot names basing on subscription name.

Default value: None

Auto  Acknowledge Mode

optional

If true, the snap acknowledges the receipt of a message when a call to receive method or when the message listener returns successfully.

Fetching Time Out

optional

The maximum time in seconds the Snap will wait for each fetching. A zero wait timeout means that fetching will be performed without waiting.

Default value: 30

Snap Execution

optional

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default value: Execute only

Snap Pack History