Cloud Firestore V1beta1 Client - Class CreateDocumentRequest (1.27.3)

Version 1.27.3

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

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.
↳ document	Google\Cloud\Firestore\V1beta1\Document Required. The document to create. name must not be set.
↳ mask	Google\Cloud\Firestore\V1beta1\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}

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.

Returns
Type	Description
Google\Cloud\Firestore\V1beta1\Document

setDocument

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

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\Document

Returns
Type	Description
$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.

Returns
Type	Description
Google\Cloud\Firestore\V1beta1\DocumentMask

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.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\DocumentMask

Returns
Type	Description
$this