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_time
of 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_time
of 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_time
of 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.
A simple field name contains only characters
a
toz
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. 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. For
map_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&y
and`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.
A simple field name contains only characters
a
toz
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. 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. For
map_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&y
and`bak\`tik`
representsbak`tik
.
-
(::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}) — The document's fields.
The map keys represent field names.
A simple field name contains only characters
a
toz
,A
toZ
,0
to9
, or_
, and must not start with0
to9
. 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. For
map_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&y
and`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_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.
#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_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.
-
(::Google::Protobuf::Timestamp) — 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.