Cloud Firestore V1beta1 Client - Class GetDocumentRequest (1.53.0)

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

The request for Firestore.GetDocument .

Generated from protobuf message google.firestore.v1beta1.GetDocumentRequest

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name
Description
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
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 60 seconds.

getName

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

Returns
Type
Description
string

setName

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

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

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

getTransaction

Reads the document in a transaction.

Returns
Type
Description
string

setTransaction

Reads the document in a transaction.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReadTime

Reads the version of the document at the given time.

This may not be older than 60 seconds.

Returns
Type
Description

setReadTime

Reads the version of the document at the given time.

This may not be older than 60 seconds.

Parameter
Name
Description
Returns
Type
Description
$this

getConsistencySelector

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