Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexOperationMetadata

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

Overview

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

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

Returns a new instance of GoogleFirestoreAdminV1IndexOperationMetadata



1276
1277
1278
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1276

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

Instance Attribute Details

#end_time ⇒ String

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

Returns:

  • (String) 


1243
1244
1245
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1243

def end_time
  @end_time
end

#index ⇒ String

The index resource that this operation is acting on. For example: projects/project_id/databases/database_id/collectionGroups/collection_id /indexes/index_id` Corresponds to the JSON propertyindex`

Returns:

  • (String) 


1250
1251
1252
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1250

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



1257
1258
1259
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1257

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:



1264
1265
1266
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1264

def progress_documents
  @progress_documents
end

#start_time ⇒ String

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

Returns:

  • (String) 


1269
1270
1271
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1269

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1274
1275
1276
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1274

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1281
1282
1283
1284
1285
1286
1287
1288
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 1281

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