Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsMetadata
- Inherits:
-
Object
- Object
- Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsMetadata
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/google/apis/firestore_v1/representations.rb
Overview
Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
Instance Attribute Summary collapse
-
#collection_ids ⇒ Array<String>
Which collection ids are being exported.
-
#end_time ⇒ String
The time this operation completed.
-
#operation_state ⇒ String
The state of the export operation.
-
#output_uri_prefix ⇒ String
Where the entities are being exported to.
-
#progress_bytes ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress
Describes the progress of the operation.
-
#progress_documents ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress
Describes the progress of the operation.
-
#start_time ⇒ String
The time this operation started.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleFirestoreAdminV1ExportDocumentsMetadata
constructor
A new instance of GoogleFirestoreAdminV1ExportDocumentsMetadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleFirestoreAdminV1ExportDocumentsMetadata
Returns a new instance of GoogleFirestoreAdminV1ExportDocumentsMetadata.
792 793 794 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 792 def initialize(**args) update!(**args) end |
Instance Attribute Details
#collection_ids ⇒ Array<String>
Which collection ids are being exported.
Corresponds to the JSON property collectionIds
755 756 757 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 755 def collection_ids @collection_ids end |
#end_time ⇒ String
The time this operation completed. Will be unset if operation still in
progress.
Corresponds to the JSON property endTime
761 762 763 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 761 def end_time @end_time end |
#operation_state ⇒ String
The state of the export operation.
Corresponds to the JSON property operationState
766 767 768 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 766 def operation_state @operation_state end |
#output_uri_prefix ⇒ String
Where the entities are being exported to.
Corresponds to the JSON property outputUriPrefix
771 772 773 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 771 def output_uri_prefix @output_uri_prefix end |
#progress_bytes ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress
Describes the progress of the operation.
Unit of work is generic and must be interpreted based on where Progress
is used.
Corresponds to the JSON property progressBytes
778 779 780 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 778 def progress_bytes @progress_bytes end |
#progress_documents ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress
Describes the progress of the operation.
Unit of work is generic and must be interpreted based on where Progress
is used.
Corresponds to the JSON property progressDocuments
785 786 787 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 785 def progress_documents @progress_documents end |
#start_time ⇒ String
The time this operation started.
Corresponds to the JSON property startTime
790 791 792 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 790 def start_time @start_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
797 798 799 800 801 802 803 804 805 |
# File 'generated/google/apis/firestore_v1/classes.rb', line 797 def update!(**args) @collection_ids = args[:collection_ids] if args.key?(:collection_ids) @end_time = args[:end_time] if args.key?(:end_time) @operation_state = args[:operation_state] if args.key?(:operation_state) @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_documents = args[:progress_documents] if args.key?(:progress_documents) @start_time = args[:start_time] if args.key?(:start_time) end |