Cloud Firestore V1beta1 Client - Class Write (1.47.2)

Version latest

• 1.47.2 (latest)
• 1.47.1
• 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 Write.

A write on a document.

Generated from protobuf message google.firestore.v1beta1.Write

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ update	Document A document to write.
↳ delete	string A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.
↳ transform	DocumentTransform Applies a transformation to a document. At most one transform per document is allowed in a given request. An update cannot follow a transform on the same document in a given request.
↳ update_mask	DocumentMask The fields to update in this write. This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by 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. The field paths in this mask must not contain a reserved field name.
↳ current_document	Precondition An optional precondition on the document. The write will fail if this is set and not met by the target document.

getUpdate

A document to write.

Returns
Type	Description
Document

setUpdate

A document to write.

Parameter
Name	Description
var	Document

Returns
Type	Description
$this

getDelete

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns
Type	Description
string

setDelete

A document name to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTransform

Applies a transformation to a document.

At most one transform per document is allowed in a given request. An update cannot follow a transform on the same document in a given request.

Returns
Type	Description
DocumentTransform

setTransform

Applies a transformation to a document.

At most one transform per document is allowed in a given request. An update cannot follow a transform on the same document in a given request.

Parameter
Name	Description
var	DocumentTransform

Returns
Type	Description
$this

getUpdateMask

The fields to update in this write.

This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by 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. The field paths in this mask must not contain a reserved field name.

Returns
Type	Description
DocumentMask

setUpdateMask

The fields to update in this write.

This field can be set only when the operation is update. If the mask is not set for an update and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by 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. The field paths in this mask must not contain a reserved field name.

Parameter
Name	Description
var	DocumentMask

Returns
Type	Description
$this

getCurrentDocument

An optional precondition on the document.

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

Returns
Type	Description
Precondition

setCurrentDocument

An optional precondition on the document.

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

Parameter
Name	Description
var	Precondition

Returns
Type	Description
$this

getOperation

Returns
Type	Description
string