Set

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

Set a document in a collection.

Examples

Set a document from a map.

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.

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

• Type: string
• Dynamic: ✔️
• Required: ❌

The Firestore document child path.

collection

• Type: string
• Dynamic: ✔️
• Required: ❌

The Firestore collection

document

• Type:
  • string
  • object
• Dynamic: ✔️
• Required: ❌

The Firestore document.

Can be a JSON string, or a map.

projectId

• Type: string
• Dynamic: ✔️
• Required: ❌

The GCP project ID.

scopes

• Type: array
• SubType: string
• Dynamic: ✔️
• Required: ❌
• Default: [https://www.googleapis.com/auth/cloud-platform]

The GCP scopes to be used.

serviceAccount

• Type: string
• Dynamic: ✔️
• Required: ❌

The GCP service account key.

Outputs

updatedTime

• Type: string
• Required: ❌
• Format: date-time

The document updated time

Definitions