Cloud Firestore V1beta1 Client - Class BatchGetDocumentsRequest (1.36.1)

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

The request for Firestore.BatchGetDocuments.

Generated from protobuf message google.firestore.v1beta1.BatchGetDocumentsRequest

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

↳ documents string[]

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

↳ mask Google\Cloud\Firestore\V1beta1\DocumentMask

The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

↳ transaction string

Reads documents in a transaction.

↳ new_transaction Google\Cloud\Firestore\V1beta1\TransactionOptions

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

↳ read_time Google\Protobuf\Timestamp

Reads documents as they were at the given time. This may not be older than 60 seconds.

getDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns
TypeDescription
string

setDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDocuments

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDocuments

The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMask

The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Returns
TypeDescription
Google\Cloud\Firestore\V1beta1\DocumentMask

setMask

The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

Parameter
NameDescription
var Google\Cloud\Firestore\V1beta1\DocumentMask
Returns
TypeDescription
$this

getTransaction

Reads documents in a transaction.

Returns
TypeDescription
string

setTransaction

Reads documents in a transaction.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNewTransaction

Starts a new transaction and reads the documents.

Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Returns
TypeDescription
Google\Cloud\Firestore\V1beta1\TransactionOptions

setNewTransaction

Starts a new transaction and reads the documents.

Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Parameter
NameDescription
var Google\Cloud\Firestore\V1beta1\TransactionOptions
Returns
TypeDescription
$this

getReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

Returns
TypeDescription
Google\Protobuf\Timestamp

setReadTime

Reads documents as they were at the given time.

This may not be older than 60 seconds.

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

getConsistencySelector

Returns
TypeDescription
string