Delete Delete

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

Delete a document from a collection.

Examples

yaml
id: gcp_firestore_delete
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.gcp.firestore.Delete
    collection: "persons"
    childPath: "1"

Properties

childPath

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

The Firestore document child path.

The Firestore document child path.

collection

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

The Firestore collection

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

Was this page helpful?