Set

Set a document in a Google Cloud Firestore collection.

yaml
type: "io.kestra.plugin.gcp.firestore.Set"

Examples

Set a document from a map.

yaml
id: gcp_firestore_set
namespace: company.team

tasks:
  - id: set
    type: io.kestra.plugin.gcp.firestore.Set
    collection: "persons"
    document:
      firstname: "John"
      lastname: "Doe"

Set a document from a JSON string.

yaml
id: gcp_firestore_set
namespace: company.team

inputs:
  - id: json_string
    type: STRING
    default: "{"firstname": "John", "lastname": "Doe"}"

tasks:
  - id: set
    type: io.kestra.plugin.gcp.firestore.Set
    collection: "persons"
    document: "{{ inputs.json_string }}"

Properties

childPath string

The Firestore document child path.

collection string

The Firestore collection

databaseId string

Default (default)

The Firestore database ID to use with this client

If you don't specify a database, the Firestore client libraries and the Google Cloud CLI connect to the (default) database by default.

document stringobject

The Firestore document.

Can be a JSON string, or a map.

impersonatedServiceAccount string

The GCP service account to impersonate.

projectId string

The GCP project ID.

scopes array

SubType string

Default ["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used.

serviceAccount string

The GCP service account.

Outputs

updatedTime string

Format date-time

The document updated time

​Set

Set