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
Methods
__construct
Constructor.
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.
string
setStreamId
The ID of the stream.
Only set on the first message, when a new stream was created.
var
string
$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.
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.
var
string
$this
getWriteResults
The result of applying the writes.
This i-th write result corresponds to the i-th write in the request.
setWriteResults
The result of applying the writes.
This i-th write result corresponds to the i-th write in the request.
$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.
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.
$this