See the supported connectors for Application Integration.
Firestore - Document Get task
The Firestore - Document Get task lets you retrieve the contents of a single Firestore document. By default, the Firestore - Document Get task fetches the latest document snapshot from your Firestore database.
Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.
Before you begin
Ensure that you perform the following tasks in your Google Cloud project before configuring the Firestore - Document Get task:
- Enable the Cloud Firestore API (
firestore.googleapis.com
). -
Create an authentication profile. Application Integration uses an authentication profile to connect to an authentication endpoint for the Firestore - Document Get task.
For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.
Configure the Firestore - Document Get task
- In the Google Cloud console, go to the Application Integration page.
- In the navigation menu, click Integrations.
The Integrations page appears listing all the integrations available in the Google Cloud project.
- Select an existing integration or click Create integration to create a new one.
If you are creating a new integration:
- Enter a name and description in the Create Integration pane.
- Select a region for the integration.
- Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
- Click Create.
This opens the integration in the integration editor.
- In the integration editor navigation bar, click Tasks to view the list of available tasks and connectors.
- Click and place the Firestore - Document Get element in the integration editor.
- Click the Firestore - Document Get element on the designer to view the Firestore - Document Get task configuration pane.
- Go to Authentication, and select an existing authentication profile that you want to use.
Optional. If you have not created an authentication profile prior to configuring the task, Click + New authentication profile and follow the steps as mentioned in Create a new authentication profile.
- Go to Task Input, and configure the displayed inputs fields using the following Task input parameters table.
Changes to the inputs fields are saved automatically.
Task input parameters
The following table describes the input parameters of the Firestore - Document Get task:
Property | Data type | Description |
---|---|---|
Region | String | Location of the Firestore database. For example, us-central1 . |
ProjectsId | String | Your Google Cloud project ID. |
DatabasesId | String | ID of the Firestore database. |
DocumentsId | String | Path or location to the Firestore document. Valid format: For more information, see Firestore data model. |
Task output
The Firestore - Document Get task returns the document data in base64-encoded format. You must decode the base64-encoded value to get the output string.
Error handling strategy
An error handling strategy for a task specifies the action to take if the task fails due to a temporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see Error handling strategies.
What's next
- Add edges and edge conditions.
- Test and publish your integration.
- Configure a trigger.
- Add a Data Mapping task.
- See all tasks for Google Cloud services.