Cloud Firestore V1 Client - Class Write (1.47.1)

Reference documentation and code samples for the Cloud Firestore V1 Client class Write.

A write on a document.

Generated from protobuf message google.firestore.v1.Write

Namespace

Google \ Cloud \ Firestore \ V1

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.
↳ 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.
↳ update_transforms array<DocumentTransform\FieldTransform>

The transforms to perform after update. This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.
↳ 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|null

hasUpdate

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

hasDelete

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.

Returns
Type Description
DocumentTransform|null

hasTransform

setTransform

Applies a transformation to a document.

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|null

hasUpdateMask

clearUpdateMask

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

getUpdateTransforms

The transforms to perform after update.

This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setUpdateTransforms

The transforms to perform after update.

This field can be set only when the operation is update. If present, this write is equivalent to performing update and transform to the same document atomically and in order.

Parameter
Name Description
var array<DocumentTransform\FieldTransform>
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|null

hasCurrentDocument

clearCurrentDocument

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