Struct googapis::google::firestore::v1beta1::Document [−][src]
pub struct Document {
pub name: String,
pub fields: HashMap<String, Value>,
pub create_time: Option<Timestamp>,
pub update_time: Option<Timestamp>,
}
Expand description
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
Fields
name: String
The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
fields: HashMap<String, Value>
The document’s fields.
The map keys represent field names.
A simple field name contains only characters a
to z
, A
to Z
,
0
to 9
, or _
, and must not start with 0
to 9
. 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 path foo.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`
represents x&y
and
`bak\`tik`
represents bak`tik
.
create_time: Option<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.
update_time: Option<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 the read_time
of a query.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Document
impl UnwindSafe for Document
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more