Preview

This product or feature is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service. Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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:

1. Enable the Cloud Firestore API (firestore.googleapis.com).

   Enable the Cloud Firestore API

2. 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

1. In the Google Cloud console, go to the Application Integration page.

   Go to Application Integration

2. In the navigation menu, click Integrations.

   The Integrations List page appears.

3. Select an existing integration or create a new integration by clicking Create integration.

   If you are creating a new integration:

   1. Enter a name and description in the Create Integration dialog.
   2. Select a Region for the integration from the list of supported regions.
   3. Click Create.

   This opens the integration in the integration designer.

4. In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
5. Click and place the Firestore - Document Get element in the integration designer.
6. Click the Firestore - Document Get element on the designer to view the Firestore - Document Get task configuration pane.
7. 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.

8. 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.

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.

Tip: You can base64-encode or decode data using the base64 command on Linux or macOS, or the Base64.exe command on Windows. Programming and scripting languages typically include libraries for base64-encoding. For command-line examples, see Decode base64 in the Cloud Text-to-Speech documentation.

Retry on failure

You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task or integration in case of an error. For more information, see Error handling strategies.

What's next

1. Add edges and edge conditions.
2. Test and publish your integration.
3. Configure a trigger.
4. Add a Data Mapping task.
5. See all tasks for Google Cloud services.