Google Cloud Set

Google Cloud Set

Certified

Create or replace a Firestore document

Writes a document in the target collection; generates an ID if childPath is not set. Accepts a map or JSON string payload.

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

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

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Document path

Optional child path; if absent, an ID is auto-generated

Collection path

Target collection name or path

Default(default)

Database ID

Defaults to (default) if not provided

Document payload

Map or JSON string to write

The GCP service account to impersonate

The GCP project ID

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

The GCP scopes to be used

The GCP service account

Formatdate-time

Updated time