Get Get

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

Get a document from a collection.

Examples

Get a document from its path.

yaml
id: gcp_firestore_get
namespace: company.team

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

Properties

childPath

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

The Firestore document child path.

collection

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

The Firestore collection

impersonatedServiceAccount

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

The GCP service account to impersonate.

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.

Outputs

row

  • Type: object
  • Required:

Map containing the fetched document.

Was this page helpful?