A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Value parameters
- createTime
-
Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the
read_time
of a query. - fields
-
The document's fields. The map keys represent field names. Field names matching the regular expression
.*
are reserved. Reserved field names are forbidden except in certain documented contexts. The field names, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. Formap_value
, the field path is represented by a dot-delimited (.
) string of segments. Each segment is either a simple field name (defined below) or a quoted field name. For example, the structured field"foo" : { map_value: { "x&y" : { string_value: "hello" }}}
foo.would be represented by the field path
x&y
to. A simple field name contains only characters
az
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. For example,foo_bar_17
. A quoted field name starts and ends withand may contain any character. Some characters, including
. For example,, must be escaped using a
&92;
andrepresents
x&y
tikrepresents
bak
tik.
- name
-
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
. - updateTime
-
Output only. The time at which the document was last changed. This value is initially set to the
create_time
then increases monotonically with each change to the document. It can also be compared to values from other documents and theread_time
of a query.
Attributes
- Companion
- object
- Source
- Document.scala
- Graph
-
- Supertypes
-
trait Updatable[Document]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any