Cloud Firestore V1 Client - Class GetDocumentRequest (1.35.0)

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

The request for Firestore.GetDocument.

Generated from protobuf message google.firestore.v1.GetDocumentRequest

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

↳ mask Google\Cloud\Firestore\V1\DocumentMask

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

↳ transaction string

Reads the document in a transaction.

↳ read_time Google\Protobuf\Timestamp

Reads the version of the document at the given time. This may not be older than 270 seconds.

getName

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Returns
TypeDescription
string

setName

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMask

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

If the 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\V1\DocumentMask|null

hasMask

clearMask

setMask

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

If the 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\V1\DocumentMask
Returns
TypeDescription
$this

getTransaction

Reads the document in a transaction.

Returns
TypeDescription
string

hasTransaction

setTransaction

Reads the document in a transaction.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadTime

Reads the version of the document at the given time.

This may not be older than 270 seconds.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasReadTime

setReadTime

Reads the version of the document at the given time.

This may not be older than 270 seconds.

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

getConsistencySelector

Returns
TypeDescription
string