View Source GoogleApi.Firestore.V1beta1.Model.Document (google_api_firestore v0.27.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_time
of a query. -
fields
(type:%{optional(String.t) => GoogleApi.Firestore.V1beta1.Model.Value.t}
, default:nil
) - 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" }}}
would be represented by the field pathfoo.`x&y`
. A simple field name contains only charactersa
toz
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. For example,foo_bar_17
. 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&y
and`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_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.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Firestore.V1beta1.Model.Document{ createTime: DateTime.t() | nil, fields: %{optional(String.t()) => GoogleApi.Firestore.V1beta1.Model.Value.t()} | nil, name: String.t() | nil, updateTime: DateTime.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.