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

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. ImportDocuments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1ImportDocumentsMetadata

Returns a new instance of GoogleFirestoreAdminV1ImportDocumentsMetadata.



2017
2018
2019
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2017

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


1977
1978
1979
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1977

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) 


1983
1984
1985
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1983

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) 


1988
1989
1990
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1988

def input_uri_prefix
  @input_uri_prefix
end

#namespace_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1993
1994
1995
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1993

def namespace_ids
  @namespace_ids
end

#operation_state ⇒ String

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

Returns:

  • (String) 


1998
1999
2000
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1998

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:



2004
2005
2006
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2004

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:



2010
2011
2012
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2010

def progress_documents
  @progress_documents
end

#start_time ⇒ String

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

Returns:

  • (String) 


2015
2016
2017
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2015

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2022

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)
  @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
  @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