Firestore - Batch Write task

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of theService Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see thelaunch stage descriptions.

TheFirestore - Batch Write task lets you execute multiple write operations as a single batch on a Cloud Firestore document. The batch write can contain any combination ofset(),update(), ordelete() operations.

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 theFirestore - Batch Write task:

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

    Enable the Cloud Firestore API

  2. Create anauthentication profile. Application Integration uses an authentication profile to connect to an authentication endpoint for theFirestore - Batch Write task.

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

Configure the Firestore - Batch Write task task

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

    Go to Application Integration

  2. In the navigation menu, clickIntegrations.

    TheIntegrations page appears listing all the integrations available in the Google Cloud project.

  3. Select an existing integration or clickCreate integration to create a new one.

    If you are creating a new integration:

    1. Enter a name and description in theCreate Integration pane.
    2. Select a region for the integration.Note: TheRegions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, clickEnable Region. SeeEnable new region for more information.
    3. Select a service account for the integration. You can change or update the service account details of an integration any time from theIntegration summary pane in the integration toolbar.Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
    4. ClickCreate. The newly created integration opens in theintegration editor.

  4. In theintegration editor navigation bar, clickTasks to view the list of available tasks and connectors.
  5. Click and place theFirestore - Batch Write element in the integration editor.
  6. Click theFirestore - Batch Write element on the designer to view theFirestore - Batch Write task configuration pane.
  7. Go toAuthentication, 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 inCreate a new authentication profile.

  8. Go toTask Input, and configure the displayed inputs fields using the followingTask input parameters table.

    Changes to the inputs fields are saved automatically.

Task input parameters

The following table describes the input parameters of theFirestore - Batch Write task:

PropertyData typeDescription
RegionStringLocation of the Firestore database. For example,us-central1.
ProjectsIdStringYour Google Cloud project ID.
DatabasesIdStringID of the Firestore database.
RequestJSONSeerequest JSON structure.

Error handling strategy

An error handling strategy for a task specifies the action to take if the task fails due to atemporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, seeError handling strategies.

Quotas and limits

For information about quotas and limits, seeQuotas and limits.

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.