View Source GoogleApi.Firestore.V1.Model.Document (google_api_firestore v0.23.0)
A Firestore document. Must not exceed 1 MiB - 4 bytes.
Attributes
-
createTime(type:DateTime.t, default:nil) - 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 theread_timeof a query. -
fields(type:%{optional(String.t) => GoogleApi.Firestore.V1.Model.Value.t}, default:nil) - The document's fields. The map keys represent field names. A simple field name contains only charactersatoz,AtoZ,0to9, or_, and must not start with0to9. For example,foo_bar_17. Field names matching the regular expression__.*__are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, 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 the simple or quoted field names of the containing fields, delimited by.. For example, the structured field"foo" : { map_value: { "x&y" : { string_value: "hello" }}}would be represented by the field pathfoo.x&y. Within a field path, a quoted field name starts and ends with`and may contain any character. Some characters, including`, must be escaped using a\. For example,`x&y`representsx&yand`bak\`tik`representsbak`tik. -
name(type:String.t, default:nil) - The resource name of the document, for exampleprojects/{project_id}/databases/{database_id}/documents/{document_path}. -
updateTime(type:DateTime.t, default:nil) - Output only. The time at which the document was last changed. This value is initially set to thecreate_timethen increases monotonically with each change to the document. It can also be compared to values from other documents and theread_timeof a query.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.Firestore.V1.Model.Document{
createTime: DateTime.t() | nil,
fields:
%{optional(String.t()) => GoogleApi.Firestore.V1.Model.Value.t()} | nil,
name: String.t() | nil,
updateTime: DateTime.t() | nil
}
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.