http4s-grpc-google-cloud-firestore-v1
3.16.0+0.0.6
API
Generated with
http4s-grpc-google-cloud-firestore-v1/com.google.firestore/com.google.firestore.v1/com.google.firestore.v1.firestore/CreateDocumentRequest

CreateDocumentRequest

com.google.firestore.v1.firestore.CreateDocumentRequest
See theCreateDocumentRequest companion object
final case class CreateDocumentRequest(parent: String, collectionId: String, documentId: String, document: Option[Document], mask: Option[DocumentMask], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateDocumentRequest]

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

Value parameters

collectionId

Required. The collection ID, relative to parent, to list. For example: chatrooms.

document

Required. The document to create. name must not be set.

documentId

The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.

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.

parent

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

Attributes

Companion
object
Source
CreateDocumentRequest.scala
Graph
Supertypes
trait Updatable[CreateDocumentRequest]
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
CreateDocumentRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
CreateDocumentRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
CreateDocumentRequest.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
CreateDocumentRequest.scala
def withDocumentId(`__v`: String): CreateDocumentRequest

Attributes

Source
CreateDocumentRequest.scala
def withParent(`__v`: String): CreateDocumentRequest

Attributes

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

Attributes

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

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