Document

com.google.firestore.v1.document.Document
See theDocument companion object
final case class Document(name: String, fields: Map[String, Value], createTime: Option[Timestamp], updateTime: Option[Timestamp], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Document]

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

Value parameters

createTime

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

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 path foo.x&y . 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. A quoted field name starts and ends with and may contain any character. Some characters, including , must be escaped using a &92;. For example, x&y represents x&y and bak&92;tik represents baktik .

name

The resource name of the document, for example projects/{project_id}/databases/{database_id}/documents/{document_path}.

updateTime

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.

Attributes

Companion
object
Source
Document.scala
Graph
Supertypes
trait Updatable[Document]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllFields(`__vs`: Iterable[(String, Value)]): Document

Attributes

Source
Document.scala
def addFields(`__vs`: (String, Value)*): Document

Attributes

Source
Document.scala

Attributes

Source
Document.scala

Attributes

Source
Document.scala

Attributes

Source
Document.scala
def companion: Document.type

Attributes

Source
Document.scala

Attributes

Source
Document.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
Document.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
Document.scala

Attributes

Source
Document.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
Document.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
Document.scala

Attributes

Source
Document.scala
def withFields(`__v`: Map[String, Value]): Document

Attributes

Source
Document.scala
def withName(`__v`: String): Document

Attributes

Source
Document.scala
def withUnknownFields(`__v`: UnknownFieldSet): Document

Attributes

Source
Document.scala

Attributes

Source
Document.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
Document.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: (Lens[Document, Document]) => () => Document*): Document

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala