Firestore - Batch Get task

Announcement: Application Integration is now available for your Google Cloud project. You can now use both Apigee Integration and Application Integration within the same Google Cloud project. Learn more

The Firestore - Batch Get task lets you send a single batch request to Cloud Firestore to get or retrieve the contents of multiple Firestore documents. Retrieved documents might not in the same order as they were requested.

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 - Batch Get task:

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

   Enable the Cloud Firestore API

2. Create an authentication profile. Apigee Integration uses an authentication profile to connect to an authentication endpoint for the Firestore - Batch Get task.

   For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.

Configure the Firestore - Batch Get task

1. In the Apigee UI, select your Apigee Organization.
2. Click Develop > Integrations.
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 - Batch Get element in the integration designer.
6. Click the Firestore - Batch Get element on the designer to view the Firestore - Batch 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 - Batch 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.
Request	JSON	See request JSON structure.

Task output

The Firestore - Batch 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.

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

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.