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.firestore/UpdateDocumentRequest

UpdateDocumentRequest

com.google.firestore.v1.firestore.UpdateDocumentRequest
See theUpdateDocumentRequest companion object
final case class UpdateDocumentRequest(document: Option[Document], updateMask: Option[DocumentMask], mask: Option[DocumentMask], currentDocument: Option[Precondition], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateDocumentRequest]

The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

Value parameters

currentDocument

An optional precondition on the document. The request will fail if this is set and not met by the target document.

document

Required. The updated document. Creates the document if it does not already exist.

mask

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

updateMask

The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.

Attributes

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

Members list

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue

Attributes

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

Attributes

Source
UpdateDocumentRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
UpdateDocumentRequest.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
UpdateDocumentRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): UpdateDocumentRequest

Attributes

Source
UpdateDocumentRequest.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
UpdateDocumentRequest.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[UpdateDocumentRequest, UpdateDocumentRequest]) => () => UpdateDocumentRequest*): UpdateDocumentRequest

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
Generated with