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. Each collection ID in this list must be unique. |
↳ 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. |
↳ namespace_ids |
array
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. |
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. Each collection ID in this list must be unique.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCollectionIds
Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.
| 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 |
|
getNamespaceIds
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNamespaceIds
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
| 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 |
ImportDocumentsRequest |
|