Cloud Firestore V1beta1 Client - Class BatchGetDocumentsResponse (1.53.0)

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

The streamed response for Firestore.BatchGetDocuments .

Generated from protobuf message google.firestore.v1beta1.BatchGetDocumentsResponse

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ found
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
Type
Description

setFound

A document that was requested.

Parameter
Name
Description
var
Returns
Type
Description
$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
Type
Description
string

setMissing

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

Parameter
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$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
Type
Description

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
Name
Description
Returns
Type
Description
$this

getResult

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: