Cloud Firestore V1 Client - Class ImportDocumentsRequest (1.35.0)

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
NameDescription
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.

↳ 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
TypeDescription
string

setName

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCollectionIds

Which collection ids to import. Unspecified means all collections included in the import.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCollectionIds

Which collection ids to import. Unspecified means all collections included in the import.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Firestore\Admin\V1\ImportDocumentsRequest