Reference documentation and code samples for the Cloud Firestore V1beta1 Client class CreateDocumentRequest.
The request for Firestore.CreateDocument.
Generated from protobuf message google.firestore.v1beta1.CreateDocumentRequest
Namespace
Google \ Cloud \ Firestore \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
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.
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}
Returns
Type
Description
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}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCollectionId
Required. The collection ID, relative to parent, to list. For example: chatrooms.
Returns
Type
Description
string
setCollectionId
Required. The collection ID, relative to parent, to list. For example: chatrooms.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDocumentId
The client-assigned document ID to use for this document.
Optional. If not specified, an ID will be assigned by the service.
Returns
Type
Description
string
setDocumentId
The client-assigned document ID to use for this document.
Optional. If not specified, an ID will be assigned by the service.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDocument
Required. The document to create. name must not be set.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1beta1 Client - Class CreateDocumentRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.CreateDocumentRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.CreateDocumentRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.CreateDocumentRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.CreateDocumentRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.CreateDocumentRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.CreateDocumentRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.CreateDocumentRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.CreateDocumentRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.CreateDocumentRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.CreateDocumentRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.CreateDocumentRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.CreateDocumentRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.CreateDocumentRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.CreateDocumentRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.CreateDocumentRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.CreateDocumentRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.CreateDocumentRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.CreateDocumentRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.CreateDocumentRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.CreateDocumentRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.CreateDocumentRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.CreateDocumentRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.CreateDocumentRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Cloud Firestore V1beta1 Client class CreateDocumentRequest.\n\nThe request for Firestore.CreateDocument.\n\nGenerated from protobuf message `google.firestore.v1beta1.CreateDocumentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`\n\n### setParent\n\nRequired. The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`\n\n### getCollectionId\n\nRequired. The collection ID, relative to `parent`, to list. For example: `chatrooms`.\n\n### setCollectionId\n\nRequired. The collection ID, relative to `parent`, to list. For example: `chatrooms`.\n\n### getDocumentId\n\nThe client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.\n\n### setDocumentId\n\nThe client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.\n\n### getDocument\n\nRequired. The document to create. `name` must not be set.\n\n### setDocument\n\nRequired. The document to create. `name` must not be set.\n\n### getMask\n\nThe fields to return. If not set, returns all fields.\n\nIf the document has a field that is not present in this mask, that field\nwill not be returned in the response.\n\n### setMask\n\nThe fields to return. If not set, returns all fields.\n\nIf the document has a field that is not present in this mask, that field\nwill not be returned in the response."]]
