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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1beta1/classes.rb,
lib/google/apis/firestore_v1beta1/representations.rb,
lib/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.



1006
1007
1008
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1006

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


973
974
975
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 973

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) 


979
980
981
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 979

def end_time
  @end_time
end

#operation_state ⇒ String

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

Returns:

  • (String) 


984
985
986
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 984

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) 


989
990
991
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 989

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:



994
995
996
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 994

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:



999
1000
1001
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 999

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) 


1004
1005
1006
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1004

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1011

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