Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest

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

Overview

The request for FirestoreAdmin.ExportDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1ExportDocumentsRequest

Returns a new instance of GoogleFirestoreAdminV1beta1ExportDocumentsRequest



805
806
807
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 805

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>) 


791
792
793
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 791

def collection_ids
  @collection_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) 


803
804
805
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 803

def output_uri_prefix
  @output_uri_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



810
811
812
813
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 810

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