Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest (v0.9.0)

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

The request for FirestoreAdmin.ExportDocuments.

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 export. Unspecified means all collections.

#collection_ids=

def collection_ids=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Which collection ids to export. Unspecified means all collections.
Returns
  • (::Array<::String>) — Which collection ids to export. Unspecified means all collections.

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

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