Cloud Firestore V1 Client - Class ImportDocumentsRequest (1.45.1)

Version 1.45.1

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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 \ V1

Methods

__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: 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}.

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: projects/{project_id}/databases/{database_id}. Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::databaseName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Firestore\Admin\V1\ImportDocumentsRequest