Cloud Firestore V1 Client - Class BatchGetDocumentsResponse (1.31.0)

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

The streamed response for Firestore.BatchGetDocuments.

Generated from protobuf message google.firestore.v1.BatchGetDocumentsResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ found Google\Cloud\Firestore\V1\Document

A document that was requested.

↳ missing string

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

↳ transaction string

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

↳ read_time Google\Protobuf\Timestamp

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

getFound

A document that was requested.

Returns
TypeDescription
Google\Cloud\Firestore\V1\Document|null

hasFound

setFound

A document that was requested.

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

getMissing

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns
TypeDescription
string

hasMissing

setMissing

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTransaction

The transaction that was started as part of this request.

Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

Returns
TypeDescription
string

setTransaction

The transaction that was started as part of this request.

Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadTime

The time at which the document was read.

This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

clearReadTime

setReadTime

The time at which the document was read.

This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getResult

Returns
TypeDescription
string