> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/google-pub-sub/consume.md). # Consume Task version: 1.0.0 Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ProjectID : `String` |

The project ID.


Default: -
Example: my-project-123456

| | SubscriptionID : `String` |

The subscription ID.


Default: -
Example: my-project-123456

| | 🗝ServiceAccountKeyJSON : `String` |

The JSON service account key that one can generate in the Google Cloud portal.


Default: -
Example: { "type": "service\_account", "project\_id": "something", "private\_key\_id": "fdsafdsafdsalmnop12345678909876543212344", "private\_key": "-----BEGIN PRIVATE KEY-----\nMIIE.......Hw==\n-----END PRIVATE KEY-----\n", "client\_email": "", "client\_id": "123456789012345678900", "auth\_uri": "", "token\_uri": "", "auth\_provider\_x509\_cert\_url": "", "client\_x509\_cert\_url": "" }

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Timeout : `Int32` |

Sets the timeout for the pull request to PubSub.

Too short timeout can lead to DeadlineExceeded exception.


Default: 20
Example: 20

| | MaxResults : `Int32` |

Maximum amount of messages that is pulled from the PubSub.


Default: 20
Example: 20

| | Acknowledge : `Boolean` |

Determines if messages are acknowledged after consuming them.


Default: True
Example: true

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Messages : `List` |

Messages consumed from Google PubSub.
Example: \[ { "Hello world!", { "myCustomAttr1": "myAttrValue1" }, "271", "2024-02-27T07:53:25Z", "key" } ]

| ## Task Changelog Changelog for Task Frends.GooglePubSub.Consume. ### \[1.0.0] - 2024-02-27 #### Changed * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/google-pub-sub/consume.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.