Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsMetadata

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

Overview

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

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

Returns a new instance of GoogleFirestoreAdminV1ImportDocumentsMetadata

[View source]

1019
1020
1021
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1019

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

Instance Attribute Details

#collection_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 

982
983
984
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 982

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) 

988
989
990
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 988

def end_time
  @end_time
end

#input_uri_prefix ⇒ String

The location of the documents being imported. Corresponds to the JSON property inputUriPrefix

Returns:

  • (String) 

993
994
995
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 993

def input_uri_prefix
  @input_uri_prefix
end

#operation_state ⇒ String

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

Returns:

  • (String) 

998
999
1000
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 998

def operation_state
  @operation_state
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:


1005
1006
1007
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1005

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:


1012
1013
1014
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1012

def progress_documents
  @progress_documents
end

#start_time ⇒ String

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

Returns:

  • (String) 

1017
1018
1019
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1017

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1024

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