Class: Google::Firestore::Admin::V1::ExportDocumentsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb

Overview

The request for FirestoreAdmin::ExportDocuments.

Instance Attribute Summary collapse

Instance Attribute Details

#collection_ids ⇒ Array<String>

Returns Which collection ids to export. Unspecified means all collections.

Returns:

  • (Array<String>) —

    Which collection ids to export. Unspecified means all collections.



139
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 139

class ExportDocumentsRequest; end

#name ⇒ String

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

Returns:

  • (String) —

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



139
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 139

class ExportDocumentsRequest; end

#output_uri_prefix ⇒ String

Returns The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.

Returns:

  • (String) —

    The output URI. Currently only supports Google Cloud Storage URIs of the form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the name of the Google Cloud Storage bucket and NAMESPACE_PATH is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.



139
 
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/firestore_admin.rb', line 139

class ExportDocumentsRequest; end