Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsMetadata

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

Overview

Metadata for google.longrunning.Operation results from FirestoreAdmin. ExportDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1ExportDocumentsMetadata

Returns a new instance of GoogleFirestoreAdminV1ExportDocumentsMetadata.



1913
1914
1915
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1913

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


1866
1867
1868
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1866

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

Returns:

  • (String) 


1872
1873
1874
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1872

def end_time
  @end_time
end

#namespace_ids ⇒ Array<String>

Which namespace IDs are being exported. Corresponds to the JSON property namespaceIds

Returns:

  • (Array<String>) 


1877
1878
1879
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1877

def namespace_ids
  @namespace_ids
end

#operation_state ⇒ String

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

Returns:

  • (String) 


1882
1883
1884
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1882

def operation_state
  @operation_state
end

#output_uri_prefix ⇒ String

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

Returns:

  • (String) 


1887
1888
1889
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1887

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

Returns:



1893
1894
1895
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1893

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

Returns:



1899
1900
1901
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1899

def progress_documents
  @progress_documents
end

#snapshot_time ⇒ String

The timestamp that corresponds to the version of the database that is being exported. If unspecified, there are no guarantees about the consistency of the documents being exported. Corresponds to the JSON property snapshotTime

Returns:

  • (String) 


1906
1907
1908
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1906

def snapshot_time
  @snapshot_time
end

#start_time ⇒ String

The time this operation started. Corresponds to the JSON property startTime

Returns:

  • (String) 


1911
1912
1913
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1911

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1918

def update!(**args)
  @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
  @end_time = args[:end_time] if args.key?(:end_time)
  @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
  @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)
  @snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
  @start_time = args[:start_time] if args.key?(:start_time)
end