firestore.FirestoreEvent interface
Stay organized with collections
Save and categorize content based on your preferences.
A CloudEvent that contains a DocumentSnapshot or a Change
Signature:
export interface FirestoreEvent<T, Params = Record<string, string>> extends CloudEvent<T>
Extends: CloudEvent<T>
Properties
Property |
Type |
Description |
database |
string |
The Firestore database |
document |
string |
The document path |
location |
string |
The location of the Firestore instance |
namespace |
string |
The Firestore namespace |
params |
Params |
An object containing the values of the path patterns. Only named capture groups will be populated - {key}, {key=*}, {key=**} |
project |
string |
The project identifier |
firestore.FirestoreEvent.database
The Firestore database
Signature:
database: string;
firestore.FirestoreEvent.document
The document path
Signature:
document: string;
firestore.FirestoreEvent.location
The location of the Firestore instance
Signature:
location: string;
firestore.FirestoreEvent.namespace
The Firestore namespace
Signature:
namespace: string;
firestore.FirestoreEvent.params
An object containing the values of the path patterns. Only named capture groups will be populated - {key}, {key=*}, {key=**}
Signature:
params: Params;
firestore.FirestoreEvent.project
The project identifier
Signature:
project: string;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-04-18 UTC.
[null,null,["Last updated 2023-04-18 UTC."],[],[],null,["A CloudEvent that contains a DocumentSnapshot or a Change\n\n**Signature:** \n\n export interface FirestoreEvent\u003cT, Params = Record\u003cstring, string\u003e\u003e extends CloudEvent\u003cT\u003e \n\n**Extends:** [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003cT\\\u003e\n\nProperties\n\nfirestore.FirestoreEvent.database\n\nThe Firestore database\n\n**Signature:** \n\n database: string;\n\nfirestore.FirestoreEvent.document\n\nThe document path\n\n**Signature:** \n\n document: string;\n\nfirestore.FirestoreEvent.location\n\nThe location of the Firestore instance\n\n**Signature:** \n\n location: string;\n\nfirestore.FirestoreEvent.namespace\n\nThe Firestore namespace\n\n**Signature:** \n\n namespace: string;\n\nfirestore.FirestoreEvent.params\n\nAn object containing the values of the path patterns. Only named capture groups will be populated - {key}, {key=\\*}, {key=\\*\\*}\n\n**Signature:** \n\n params: Params;\n\nfirestore.FirestoreEvent.project\n\nThe project identifier\n\n**Signature:** \n\n project: string;"]]