Cloud Firestore V1beta1 Client - Class RunQueryResponse (1.36.1)

Version 1.36.1

• 1.47.0 (latest)
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

The response for Firestore.RunQuery.

Generated from protobuf message google.firestore.v1beta1.RunQueryResponse

Namespace

Google \ Cloud \ Firestore \ V1beta1

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\V1beta1\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.

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\V1beta1\Document

setDocument

A query result.

Not set when reporting partial progress.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\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

setReadTime

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.

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