# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 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::ExportDocumentsRequest.

The request for
[FirestoreAdmin.ExportDocuments](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_export_documents_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#export_documents (method)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #collection_ids

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

**Returns**

- (::Array\<::String\>) --- IDs of the collection groups to export. Unspecified means all collection groups. Each collection group in this list must be unique.

### #collection_ids=

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

**Parameter**

- **value** (::Array\<::String\>) --- IDs of the collection groups to export. Unspecified means all collection groups. Each collection group in this list must be unique.
**Returns**

- (::Array\<::String\>) --- IDs of the collection groups to export. Unspecified means all collection groups. Each collection group in this list must be unique.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- 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}`.

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

### #output_uri_prefix

    def output_uri_prefix() -> ::String

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

### #output_uri_prefix=

    def output_uri_prefix=(value) -> ::String

**Parameter**

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

### #snapshot_time

    def snapshot_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Timestamp)) --- The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than [earliestVersionTime](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database#Google__Cloud__Firestore__Admin__V1__Database_earliest_version_time_instance_ "Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time (method)"). If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.

### #snapshot_time=

    def snapshot_time=(value) -> ::Google::Protobuf::Timestamp

**Parameter**

- **value** ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Timestamp)) --- The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than [earliestVersionTime](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database#Google__Cloud__Firestore__Admin__V1__Database_earliest_version_time_instance_ "Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time (method)"). If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.
**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Timestamp)) --- The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than [earliestVersionTime](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database#Google__Cloud__Firestore__Admin__V1__Database_earliest_version_time_instance_ "Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time (method)"). If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.