Cloud Firestore V1beta1 Client - Class UpdateDocumentRequest (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 UpdateDocumentRequest.

The request for Firestore.UpdateDocument.

Generated from protobuf message google.firestore.v1beta1.UpdateDocumentRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ document	Google\Cloud\Firestore\V1beta1\Document Required. The updated document. Creates the document if it does not already exist.
↳ update_mask	Google\Cloud\Firestore\V1beta1\DocumentMask 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.
↳ 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.
↳ current_document	Google\Cloud\Firestore\V1beta1\Precondition An optional precondition on the document. The request will fail if this is set and not met by the target document.

getDocument

Required. The updated document.

Creates the document if it does not already exist.

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

setDocument

Required. The updated document.

Creates the document if it does not already exist.

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

Returns
Type	Description
$this

getUpdateMask

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.

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

setUpdateMask

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.

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

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

getCurrentDocument

An optional precondition on the document.

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

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

setCurrentDocument

An optional precondition on the document.

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

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

Returns
Type	Description
$this