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 \ V1Methods
__construct
Constructor.
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 must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
getName
Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
string
setName
Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}
.
var
string
$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.
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.
$this
getTransaction
Reads the document in a transaction.
string
hasTransaction
setTransaction
Reads the document in a transaction.
var
string
$this
getReadTime
Reads the version of the document at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
hasReadTime
setReadTime
Reads the version of the document at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
$this
getConsistencySelector
string
