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.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}
.
↳ 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}
.
string
setName
Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}
.
var
string
$this
getCollectionIds
Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.
setCollectionIds
Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.
var
string[]
$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 .
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 .
var
string
$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.
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.
var
string[]
$this
static::build
name
string
Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}
. Please see FirestoreAdminClient::databaseName()
for help formatting this field.
