Cloud Firestore V1 Client - Class RunQueryResponse (1.31.0)

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

Generated from protobuf message google.firestore.v1.RunQueryResponse

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ transaction`	`string` The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
`↳ document`	`Google\Cloud\Firestore\V1\Document` A query result, not set when reporting partial progress.
`↳ read_time`	`Google\Protobuf\Timestamp` The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
`↳ skipped_results`	`int` The number of results that have been skipped due to an offset between the last response and the current response.
`↳ done`	`bool` If present, Firestore has completely finished the request and no more documents will be returned.

getTransaction

The transaction that was started as part of this request.

Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.

Returns
Type	Description
`string`

setTransaction

The transaction that was started as part of this request.

Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDocument

A query result, not set when reporting partial progress.

Returns
Type	Description
`Google\Cloud\Firestore\V1\Document\|null`

hasDocument

clearDocument

setDocument

A query result, not set when reporting partial progress.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\Document`

Returns
Type	Description
`$this`

getReadTime

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasReadTime

clearReadTime

setReadTime

If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getSkippedResults

The number of results that have been skipped due to an offset between the last response and the current response.

Returns
Type	Description
`int`

setSkippedResults

The number of results that have been skipped due to an offset between the last response and the current response.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDone

If present, Firestore has completely finished the request and no more documents will be returned.

Returns
Type	Description
`bool`

hasDone

setDone

If present, Firestore has completely finished the request and no more documents will be returned.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getContinuationSelector

Returns
Type	Description
`string`