Class: Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ExportDocumentsMetadata

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1beta2ExportDocumentsMetadata

Returns a new instance of GoogleFirestoreAdminV1beta2ExportDocumentsMetadata



89
90
91
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 89

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#collection_idsArray<String>

Which collection ids are being exported. Corresponds to the JSON property collectionIds

Returns:

  • (Array<String>)


52
53
54
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 52

def collection_ids
  @collection_ids
end

#end_timeString

The time this operation completed. Will be unset if operation still in progress. Corresponds to the JSON property endTime

Returns:

  • (String)


58
59
60
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 58

def end_time
  @end_time
end

#operation_stateString

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

Returns:

  • (String)


63
64
65
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 63

def operation_state
  @operation_state
end

#output_uri_prefixString

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

Returns:

  • (String)


68
69
70
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 68

def output_uri_prefix
  @output_uri_prefix
end

#progress_bytesGoogle::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress

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



75
76
77
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 75

def progress_bytes
  @progress_bytes
end

#progress_documentsGoogle::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress

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



82
83
84
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 82

def progress_documents
  @progress_documents
end

#start_timeString

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

Returns:

  • (String)


87
88
89
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 87

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



94
95
96
97
98
99
100
101
102
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 94

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