Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

The request for FirestoreAdmin.ExportDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1ExportDocumentsRequest

Returns a new instance of GoogleFirestoreAdminV1ExportDocumentsRequest.



1037
1038
1039
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1037

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#collection_ids ⇒ Array<String>

Which collection ids to export. Unspecified means all collections. Corresponds to the JSON property collectionIds

Returns:

  • (Array<String>) 


1015
1016
1017
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1015

def collection_ids
  @collection_ids
end

#namespace_ids ⇒ 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. Corresponds to the JSON property namespaceIds

Returns:

  • (Array<String>) 


1024
1025
1026
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1024

def namespace_ids
  @namespace_ids
end

#output_uri_prefix ⇒ 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. Corresponds to the JSON property outputUriPrefix

Returns:

  • (String) 


1035
1036
1037
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1035

def output_uri_prefix
  @output_uri_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1042
1043
1044
1045
1046
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1042

def update!(**args)
  @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
  @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
  @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
end