Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest
- 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
-
#collection_ids ⇒ Array<String>
Which collection ids to export.
-
#output_uri_prefix ⇒ String
The output URI.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1ExportDocumentsRequest
constructor
A new instance of GoogleFirestoreAdminV1beta1ExportDocumentsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1ExportDocumentsRequest
Returns a new instance of GoogleFirestoreAdminV1beta1ExportDocumentsRequest
823 824 825 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 823 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
809 810 811 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 809 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
821 822 823 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 821 def output_uri_prefix @output_uri_prefix end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
828 829 830 831 |
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 828 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 |