Cloud Firestore V1 Client - Class WriteResponse (1.44.1)

Version 1.44.1

• 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

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

The response for Firestore.Write.

Generated from protobuf message google.firestore.v1.WriteResponse

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ stream_id	string The ID of the stream. Only set on the first message, when a new stream was created.
↳ stream_token	string A token that represents the position of this response in the stream. This can be used by a client to resume the stream at this point. This field is always set.
↳ write_results	array<Google\Cloud\Firestore\V1\WriteResult> The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
↳ commit_time	Google\Protobuf\Timestamp The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

getStreamId

The ID of the stream.

Only set on the first message, when a new stream was created.

Returns
Type	Description
string

setStreamId

The ID of the stream.

Only set on the first message, when a new stream was created.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStreamToken

A token that represents the position of this response in the stream.

This can be used by a client to resume the stream at this point. This field is always set.

Returns
Type	Description
string

setStreamToken

A token that represents the position of this response in the stream.

This can be used by a client to resume the stream at this point. This field is always set.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWriteResults

The result of applying the writes.

This i-th write result corresponds to the i-th write in the request.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setWriteResults

The result of applying the writes.

This i-th write result corresponds to the i-th write in the request.

Parameter
Name	Description
var	array<Google\Cloud\Firestore\V1\WriteResult>

Returns
Type	Description
$this

getCommitTime

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCommitTime

clearCommitTime

setCommitTime

The time at which the commit occurred. Any read with an equal or greater read_time is guaranteed to see the effects of the write.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this