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.
| 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: |
↳ 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 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}.
| 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 |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\DocumentMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransaction
Reads the document in a transaction.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTransaction
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 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string |
|