Class: Google::Apis::FirestoreV1beta1::IndexOperationMetadata

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

Overview

Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation.

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

Returns a new instance of IndexOperationMetadata



823
824
825
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 823

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

Instance Attribute Details

#cancelled ⇒ Boolean Also known as: cancelled?

True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but google.longrunning.Operation.done will be false. Corresponds to the JSON property cancelled

Returns:

  • (Boolean) 


793
794
795
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 793

def cancelled
  @cancelled
end

#document_progress ⇒ Google::Apis::FirestoreV1beta1::Progress

Measures the progress of a particular metric. Corresponds to the JSON property documentProgress

Returns:



799
800
801
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 799

def document_progress
  @document_progress
end

#end_time ⇒ String

The time the operation ended, either successfully or otherwise. Unset if the operation is still active. Corresponds to the JSON property endTime

Returns:

  • (String) 


805
806
807
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 805

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/indexes/index_id` Corresponds to the JSON propertyindex`

Returns:

  • (String) 


811
812
813
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 811

def index
  @index
end

#operation_type ⇒ String

The type of index operation. Corresponds to the JSON property operationType

Returns:

  • (String) 


816
817
818
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 816

def operation_type
  @operation_type
end

#start_time ⇒ String

The time that work began on the operation. Corresponds to the JSON property startTime

Returns:

  • (String) 


821
822
823
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 821

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



828
829
830
831
832
833
834
835
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 828

def update!(**args)
  @cancelled = args[:cancelled] if args.key?(:cancelled)
  @document_progress = args[:document_progress] if args.key?(:document_progress)
  @end_time = args[:end_time] if args.key?(:end_time)
  @index = args[:index] if args.key?(:index)
  @operation_type = args[:operation_type] if args.key?(:operation_type)
  @start_time = args[:start_time] if args.key?(:start_time)
end