Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Document.
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — 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_timeof a query.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp-
value (::Google::Protobuf::Timestamp) — 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_timeof a query.
-
(::Google::Protobuf::Timestamp) — 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_timeof a query.
#fields
def fields() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}-
(::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — 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. For
map_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 characters
atoz,AtoZ,0to9, or_, and must not start with0to9. 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&yand`bak\`tik`representsbak`tik.
#fields=
def fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}-
value (::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — 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. For
map_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 characters
atoz,AtoZ,0to9, or_, and must not start with0to9. 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&yand`bak\`tik`representsbak`tik.
-
(::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — 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. For
map_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 characters
atoz,AtoZ,0to9, or_, and must not start with0to9. 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&yand`bak\`tik`representsbak`tik.
#name
def name() -> ::String-
(::String) — The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
#name=
def name=(value) -> ::String-
value (::String) — The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
-
(::String) — The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — Output only. The time at which the document was last changed.
This value is initially set to the
create_timethen increases monotonically with each change to the document. It can also be compared to values from other documents and theread_timeof a query.
#update_time=
def update_time=(value) -> ::Google::Protobuf::Timestamp-
value (::Google::Protobuf::Timestamp) — Output only. The time at which the document was last changed.
This value is initially set to the
create_timethen increases monotonically with each change to the document. It can also be compared to values from other documents and theread_timeof a query.
-
(::Google::Protobuf::Timestamp) — Output only. The time at which the document was last changed.
This value is initially set to the
create_timethen increases monotonically with each change to the document. It can also be compared to values from other documents and theread_timeof a query.