Google Cloud Pub/Sub Connector

Google Cloud Pub/Sub provides messaging between applications. Publisher applications can send messages to a 'topic' and other applications can subscribe to that topic to receive the messages.

Connections

Google Pub/Sub Private Key

Authenticate requests to Google Cloud Storage using values obtained from the Google Cloud Platform.

Input	Comments	Default
Client Email	The email address of the client you would like to connect.
Private Key	The private key of the client you would like to connect.
Project Id	The ID of the project that hosts the storage bucket
Scopes	Space delimited listing of scopes. https://developers.google.com/identity/protocols/oauth2/scopes#pubsub	https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/pubsub

OAuth2

OAuth2 Connection

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Scopes	Space delimited listing of scopes. https://developers.google.com/identity/protocols/oauth2/scopes#pubsub	https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/pubsub
Client ID	The Google Cloud Pub/Sub app's Client Identifier.
Client Secret	The Google Cloud Pub/Sub app's Client Secret.

Triggers

PubSub Notification

PubSub Notification Trigger Settings

Actions

Create Subscription

Creates a subscription to a given topic.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to create.
Topic	The name of the topic from which this subscription is receiving messages. The value of this field will be deleted-topic if the topic has been deleted.
Topic Name or Full Format	Select if the provided topic input is a full format topic name including project, for example: 'projects/projectId/topics/topicName' or just the topic name, for example: 'topicName'
Push Config	If push delivery is used with this subscription, this field is used to configure it.
BigQuery Config	If delivery to BigQuery is used with this subscription, this field is used to configure it.
Ack Deadline Seconds	The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using non-streaming pull or send the ackId in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.
Retain Acked Messages	Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. This must be true if you would like to subscriptions.seek to a timestamp in the past to replay previously-acknowledged messages.	false
Message Retention Duration	Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.
Labels	The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
Enable Message Ordering	If true, messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.	false
Expiration Policy	A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expirationPolicy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expirationPolicy.ttl is 1 day. If expirationPolicy is set, but expirationPolicy.ttl is not set, the subscription never expires.
Filter	An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
Dead Letter Policy	A policy that specifies the conditions for dead lettering messages in this subscription. If deadLetterPolicy is not set, dead lettering is disabled.
Retry Policy	A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Detached	Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. subscriptions.pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.	false
Enable Exactly Once Delivery	If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this subscription: - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. - An acknowledged message will not be resent to a subscriber.	false
Topic Message Retention Duration	Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topicMessageRetentionDuration are always available to subscribers. See the messageRetentionDuration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.
State	Output only. An output-only field indicating whether or not the subscription can receive messages.

Create Topic

Creates the given topic with the given name.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Topic	Name of the new topic
Labels	The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
Message Storage Policy	Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
KMS Key Name	The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
Schema Settings	Settings for validating messages published against a schema.
Satisfies PZS	Output only. Reserved for future use.	false
Message Retention Duration	Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.

Create Webhook Subscription

Creates a webhook subscription to a given topic.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription Name	The name of the subscription to create.
Topic	The name of the topic to get.
Topic Name or Full Format	Select if the provided topic input is a full format topic name including project, for example: 'projects/projectId/topics/topicName' or just the topic name, for example: 'topicName'
Webhook URL	The URL of the endpoint to which messages are sent. This is typically the webhook URL of a sibling flow.

Delete Subscription

Deletes an existing subscription.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to get.
Subscription Name or Full Format	Select if the provided subscription input is a full format subscription name including project, for example: 'projects/projectId/subscriptions/subscriptionName' or just the topic name, for example: 'subscriptionName'

Delete Topic

Deletes the topic with the given name.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Topic	The name of the topic to get.
Topic Name or Full Format	Select if the provided topic input is a full format topic name including project, for example: 'projects/projectId/topics/topicName' or just the topic name, for example: 'topicName'

Get Policy

Gets the access control policy for a resource.

Input	Comments	Default
Connection
Resource	The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Requested Policy Version	The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.

Get Subscription

Gets the configuration details of a subscription.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to get.
Subscription Name or Full Format	Select if the provided subscription input is a full format subscription name including project, for example: 'projects/projectId/subscriptions/subscriptionName' or just the topic name, for example: 'subscriptionName'

Get Topic

Gets the configuration of a topic.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Topic	The name of the topic to get.
Topic Name or Full Format	Select if the provided topic input is a full format topic name including project, for example: 'projects/projectId/topics/topicName' or just the topic name, for example: 'topicName'

List Subscriptions

Lists matching Subscriptions.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Page Token	Maximum number of subscriptions to return.
Page Size	The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior subscriptions.list call, and that the system should return the next page of data.

List Topics

Lists matching topics.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Page Token	Page token, returned by a previous call, to request the next page of results
Page Size	Optional. The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior topics.list call, and that the system should return the next page of data.

Pull Messages

Pulls messages from the server.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to get.
Subscription Name or Full Format	Select if the provided subscription input is a full format subscription name including project, for example: 'projects/projectId/subscriptions/subscriptionName' or just the topic name, for example: 'subscriptionName'
Max Messages	The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
Return Immediately	If this field set to true, the system will respond immediately even if it there are no messages available to return in the subscriptions.pull response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to true is discouraged because it adversely impacts the performance of subscriptions.pull operations. We recommend that users do not set this field.	false

Raw Request

Send raw HTTP request to Google Cloud Pub/Sub

Input	Comments	Default
Connection
API Version	The API version to use. This is used to construct the base URL for the request.	v1
URL	Input the path only (/projects/{projectId}/topics), The base URL is already included (https://pubsub.googleapis.com/{version}). For example, to connect to https://pubsub.googleapis.com/v1/projects/{projectId}/topics, only /projects/{projectId}/topics is entered in this field.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type.	false
Max Retry Count	The maximum number of retries to attempt.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries.	false

Set Gmail IAM Policy for Topic

Configure a topic to allow publish notifications from Gmail.

Input	Comments	Default
Connection
Topic	The full name of the topic to set the IAM policy for

Set Policy

Sets the access control policy on the specified resource.

Input	Comments	Default
Connection
Resource	The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
Policy	The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.

Update Push Config

This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to get.
Subscription Name or Full Format	Select if the provided subscription input is a full format subscription name including project, for example: 'projects/projectId/subscriptions/subscriptionName' or just the topic name, for example: 'subscriptionName'
Push Endpoint	A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.
Attributes	Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The only supported values for the x-goog-version attribute are: - v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. - v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.
Oidc Token	If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

Update Subscription

Updates an existing subscription.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Subscription	The name of the subscription to get.
Topic	The name of the topic from which this subscription is receiving messages. The value of this field will be deleted-topic if the topic has been deleted.
Subscription Name or Full Format	Select if the provided subscription input is a full format subscription name including project, for example: 'projects/projectId/subscriptions/subscriptionName' or just the topic name, for example: 'subscriptionName'
Update Mask	Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if updateMask contains 'messageStoragePolicy' but the messageStoragePolicy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level. This is a comma-separated list of fully qualified names of fields. Example: 'user.displayName,photo'.
Push Config	If push delivery is used with this subscription, this field is used to configure it.
BigQuery Config	If delivery to BigQuery is used with this subscription, this field is used to configure it.
Ack Deadline Seconds	The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using non-streaming pull or send the ackId in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.
Retain Acked Messages	Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. This must be true if you would like to subscriptions.seek to a timestamp in the past to replay previously-acknowledged messages.	false
Message Retention Duration	Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.
Labels	The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
Enable Message Ordering	If true, messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.	false
Expiration Policy	A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expirationPolicy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expirationPolicy.ttl is 1 day. If expirationPolicy is set, but expirationPolicy.ttl is not set, the subscription never expires.
Filter	An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
Dead Letter Policy	A policy that specifies the conditions for dead lettering messages in this subscription. If deadLetterPolicy is not set, dead lettering is disabled.
Retry Policy	A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Detached	Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. subscriptions.pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.	false
Enable Exactly Once Delivery	If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this subscription: - The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. - An acknowledged message will not be resent to a subscriber.	false
Topic Message Retention Duration	Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topicMessageRetentionDuration are always available to subscribers. See the messageRetentionDuration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.
State	Output only. An output-only field indicating whether or not the subscription can receive messages.

Update Topic

Updates an existing topic.

Input	Comments	Default
Connection
Project ID	Project ID of the datasets to be listed
Topic	Name of the topic
Topic Name or Full Format	Select if the provided topic input is a full format topic name including project, for example: 'projects/projectId/topics/topicName' or just the topic name, for example: 'topicName'
Update Mask	Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if updateMask contains 'messageStoragePolicy' but the messageStoragePolicy is not set in the topic provided above, then the updated value is determined by the policy configured at the project or organization level. This is a comma-separated list of fully qualified names of fields. Example: 'user.displayName,photo'.
Labels	The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
Message Storage Policy	Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
KMS Key Name	The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
Schema Settings	Settings for validating messages published against a schema.
Satisfies PZS	Output only. Reserved for future use.	false
Message Retention Duration	Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with 's'. Example: '1200s'.