Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest (v0.17.1)

Version latest

• 0.17.1 (latest)
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.3
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest.

The request for FirestoreAdmin.ImportDocuments.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#collection_ids

def collection_ids() -> ::Array<::String>

Returns

• (::Array<::String>) — Which collection ids to import. Unspecified means all collections included in the import.

#collection_ids=

def collection_ids=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Which collection ids to import. Unspecified means all collections included in the import.

Returns

• (::Array<::String>) — Which collection ids to import. Unspecified means all collections included in the import.

#input_uri_prefix

def input_uri_prefix() -> ::String

Returns

• (::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.

#input_uri_prefix=

def input_uri_prefix=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#name

def name() -> ::String

Returns

• (::String) — Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

Returns

• (::String) — Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

#namespace_ids

def namespace_ids() -> ::Array<::String>

Returns

• (::Array<::String>) — 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.

#namespace_ids=

def namespace_ids=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — 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

• (::Array<::String>) — 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.