Cloud Firestore V1beta1 Client - Class Write (1.39.0)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ update Google\Cloud\Firestore\V1beta1\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 Google\Cloud\Firestore\V1beta1\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 Google\Cloud\Firestore\V1beta1\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 Google\Cloud\Firestore\V1beta1\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
TypeDescription
Google\Cloud\Firestore\V1beta1\Document

setUpdate

A document to write.

Parameter
NameDescription
var Google\Cloud\Firestore\V1beta1\Document
Returns
TypeDescription
$this

getDelete

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

Returns
TypeDescription
string

setDelete

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\Firestore\V1beta1\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
NameDescription
var Google\Cloud\Firestore\V1beta1\DocumentTransform
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\Firestore\V1beta1\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
NameDescription
var Google\Cloud\Firestore\V1beta1\DocumentMask
Returns
TypeDescription
$this

getCurrentDocument

An optional precondition on the document.

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

Returns
TypeDescription
Google\Cloud\Firestore\V1beta1\Precondition

setCurrentDocument

An optional precondition on the document.

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

Parameter
NameDescription
var Google\Cloud\Firestore\V1beta1\Precondition
Returns
TypeDescription
$this

getOperation

Returns
TypeDescription
string