Class: Google::Apis::FirestoreV1beta1::Progress

Inherits:

Object

• Object
• Google::Apis::FirestoreV1beta1::Progress

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

Measures the progress of a particular metric.

Instance Attribute Summary

• #work_completed ⇒ Fixnum

  An estimate of how much work has been completed.

• #work_estimated ⇒ Fixnum

  An estimate of how much work needs to be performed.

Instance Method Summary

• #initialize(**args) ⇒ Progress constructor

  A new instance of Progress.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Progress

Returns a new instance of Progress

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1248

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

Instance Attribute Details

#work_completed ⇒ Fixnum

An estimate of how much work has been completed. Note that this may be greater than work_estimated. Corresponds to the JSON property workCompleted

Returns:

• (Fixnum)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1240

def work_completed
  @work_completed
end

#work_estimated ⇒ Fixnum

An estimate of how much work needs to be performed. Zero if the work estimate is unavailable. May change as work progresses. Corresponds to the JSON property workEstimated

Returns:

• (Fixnum)

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1246

def work_estimated
  @work_estimated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1253

def update!(**args)
  @work_completed = args[:work_completed] if args.key?(:work_completed)
  @work_estimated = args[:work_estimated] if args.key?(:work_estimated)
end