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.



2072
2073
2074
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2072

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


2025
2026
2027
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2025

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) 


2031
2032
2033
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2031

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


2036
2037
2038
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2036

def namespace_ids
  @namespace_ids
end

#operation_state ⇒ String

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

Returns:

  • (String) 


2041
2042
2043
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2041

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) 


2046
2047
2048
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2046

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:



2052
2053
2054
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2052

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:



2058
2059
2060
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2058

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) 


2065
2066
2067
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2065

def snapshot_time
  @snapshot_time
end

#start_time ⇒ String

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

Returns:

  • (String) 


2070
2071
2072
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2070

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2077

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