Acknowledge

In this article

Overview

This Snap is used to acknowledge the pubsub messages with ack ids read by a Pubsub Subscriber used in the upstream Snap. This snap can also be used with out the subscriber snap, by passing the ackIds directly from inputstream.

Note: 

  1. This snap supports acknowledging for a single ackId or for a batch of ackIds.

  2. For single message , the ackId can be given directly in the property “Acknowledgment Id”.

  3. For batch messages , the ackIds can be given in a json and mapped to the property “Acknowledgment Id”.

  4. If batchsize > 1, and an acknowledgement in a batch fails means that batch will fail completely. The ackIds belongs to the failed batch will be sent to the error view.

Snap Type

Acknowledge Snap is a Write 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 acknowledge the messages.

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