Class: Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexOperationMetadata

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.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) ⇒ GoogleFirestoreAdminV1beta2IndexOperationMetadata

Returns a new instance of GoogleFirestoreAdminV1beta2IndexOperationMetadata



369
370
371
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 369

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

Instance Attribute Details

#end_timeString

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

Returns:

  • (String)


336
337
338
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 336

def end_time
  @end_time
end

#indexString

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)


343
344
345
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 343

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



350
351
352
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 350

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



357
358
359
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 357

def progress_documents
  @progress_documents
end

#start_timeString

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

Returns:

  • (String)


362
363
364
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 362

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


367
368
369
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 367

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



374
375
376
377
378
379
380
381
# File 'generated/google/apis/firestore_v1beta2/classes.rb', line 374

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