Class: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsMetadata

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

Metadata for ExportDocuments operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta1ExportDocumentsMetadata

Returns a new instance of GoogleFirestoreAdminV1beta1ExportDocumentsMetadata.



818
819
820
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 818

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

Returns:

  • (Array<String>) 


785
786
787
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 785

def collection_ids
  @collection_ids
end

#end_time ⇒ String

The time the operation ended, either successfully or otherwise. Unset if the operation is still active. Corresponds to the JSON property endTime

Returns:

  • (String) 


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

def end_time
  @end_time
end

#operation_state ⇒ String

The state of the export operation. Corresponds to the JSON property operationState

Returns:

  • (String) 


796
797
798
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 796

def operation_state
  @operation_state
end

#output_uri_prefix ⇒ String

Where the entities are being exported to. Corresponds to the JSON property outputUriPrefix

Returns:

  • (String) 


801
802
803
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 801

def output_uri_prefix
  @output_uri_prefix
end

#progress_bytes ⇒ Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress

Measures the progress of a particular metric. Corresponds to the JSON property progressBytes

Returns:



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

def progress_bytes
  @progress_bytes
end

#progress_documents ⇒ Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress

Measures the progress of a particular metric. Corresponds to the JSON property progressDocuments

Returns:



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

def progress_documents
  @progress_documents
end

#start_time ⇒ String

The time that work began on the operation. Corresponds to the JSON property startTime

Returns:

  • (String) 


816
817
818
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 816

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



823
824
825
826
827
828
829
830
831
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 823

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