Reference documentation and code samples for the Cloud Firestore V1 Client class ImportDocumentsRequest.
The request for FirestoreAdmin.ImportDocuments.
Generated from protobuf message google.firestore.admin.v1.ImportDocumentsRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Database to import into. Should be of the form: |
↳ collection_ids |
array
Which collection ids to import. Unspecified means all collections included in the import. |
↳ input_uri_prefix |
string
Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. |
getName
Required. Database to import into. Should be of the form:
projects/{project_id}/databases/{database_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Database to import into. Should be of the form:
projects/{project_id}/databases/{database_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCollectionIds
Which collection ids to import. Unspecified means all collections included in the import.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCollectionIds
Which collection ids to import. Unspecified means all collections included in the import.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputUriPrefix
Location of the exported files.
This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
| Returns | |
|---|---|
| Type | Description |
string | |
setInputUriPrefix
Location of the exported files.
This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Database to import into. Should be of the form:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\ImportDocumentsRequest | |