http4s-grpc-google-cloud-firestore-v1
3.21.3+0.0.6
API
Generated with
http4s-grpc-google-cloud-firestore-v1/com.google.firestore/com.google.firestore.v1/com.google.firestore.v1.document

com.google.firestore.v1.document

package com.google.firestore.v1.document

Members list

Type members

Classlikes

final case class ArrayValue(values: Seq[Value], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ArrayValue]

An array value.

An array value.

Value parameters

values

Values in the array.

Attributes

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

Attributes

Companion
class
Source
ArrayValue.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ArrayValue]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
ArrayValue.type
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.

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
Supertypes
trait Updatable[Document]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Document extends GeneratedMessageCompanion[Document]

Attributes

Companion
class
Source
Document.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Document]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Document.type
object DocumentProto extends GeneratedFileObject

Attributes

Source
DocumentProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class MapValue(fields: Map[String, Value], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MapValue]

A map value.

A map value.

Value parameters

fields

The map'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 map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

Attributes

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

Attributes

Companion
class
Source
MapValue.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[MapValue]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
MapValue.type
final case class Value(valueType: ValueTypeOneof, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Value]

A message that can hold any of the supported value types.

A message that can hold any of the supported value types.

Attributes

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

Attributes

Companion
class
Source
Value.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Value]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Value.type
Generated with