Reference documentation and code samples for the Cloud Firestore V1 Client class CreateDocumentRequest.
The request for Firestore.CreateDocument .
Generated from protobuf message google.firestore.v1.CreateDocumentRequest
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents
or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}
↳ collection_id
string
Required. The collection ID, relative to parent
, to list. For example: chatrooms
.
↳ document_id
string
The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
↳ document
↳ mask
DocumentMask
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.
getParent
Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents
or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}
string
setParent
Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents
or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}
var
string
$this
getCollectionId
Required. The collection ID, relative to parent
, to list. For example: chatrooms
.
string
setCollectionId
Required. The collection ID, relative to parent
, to list. For example: chatrooms
.
var
string
$this
getDocumentId
The client-assigned document ID to use for this document.
Optional. If not specified, an ID will be assigned by the service.
string
setDocumentId
The client-assigned document ID to use for this document.
Optional. If not specified, an ID will be assigned by the service.
var
string
$this
getDocument
Required. The document to create. name
must not be set.
hasDocument
clearDocument
setDocument
Required. The document to create. name
must not be set.
$this
getMask
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.
hasMask
clearMask
setMask
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.
$this
