Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1ImportDocumentsRequest

Returns a new instance of GoogleFirestoreAdminV1ImportDocumentsRequest.



2016
2017
2018
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2016

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

Instance Attribute Details

#collection_ids ⇒ Array<String>

Which collection ids to import. Unspecified means all collections included in the import. Each collection id in this list must be unique. Corresponds to the JSON property collectionIds

Returns:

  • (Array<String>) 


1998
1999
2000
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1998

def collection_ids
  @collection_ids
end

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

Returns:

  • (String) 


2005
2006
2007
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2005

def input_uri_prefix
  @input_uri_prefix
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>) 


2014
2015
2016
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2014

def namespace_ids
  @namespace_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2021
2022
2023
2024
2025
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2021

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