Class: Smplkit::Jobs::Usage

Inherits:
Struct
  • Object
show all
Defined in:
lib/smplkit/jobs/models.rb

Overview

Current-period usage against the account’s plan allotments (read-only).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#active_jobs ⇒ Integer

Returns Number of currently-enabled jobs.

Returns:

  • (Integer) —

    Number of currently-enabled jobs.



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/smplkit/jobs/models.rb', line 416

Usage = Struct.new(
  :period, :runs_used, :runs_included, :active_jobs, :active_jobs_limit,
  keyword_init: true
) do
  # @api private — Build a {Usage} snapshot from a JSON:API resource
  #   returned by the jobs service.
  #
  # @param resource [Object] The JSON:API resource (attributes).
  # @return [Usage] The usage snapshot.
  def self.from_resource(resource)
    a = resource.attributes
    new(
      period: a.period,
      runs_used: a.runs_used,
      runs_included: a.runs_included,
      active_jobs: a.active_jobs,
      active_jobs_limit: a.active_jobs_limit
    )
  end
end

#active_jobs_limit ⇒ Integer

Returns Maximum enabled jobs the plan allows (-1 means unlimited).

Returns:

  • (Integer) —

    Maximum enabled jobs the plan allows (-1 means unlimited).



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/smplkit/jobs/models.rb', line 416

Usage = Struct.new(
  :period, :runs_used, :runs_included, :active_jobs, :active_jobs_limit,
  keyword_init: true
) do
  # @api private — Build a {Usage} snapshot from a JSON:API resource
  #   returned by the jobs service.
  #
  # @param resource [Object] The JSON:API resource (attributes).
  # @return [Usage] The usage snapshot.
  def self.from_resource(resource)
    a = resource.attributes
    new(
      period: a.period,
      runs_used: a.runs_used,
      runs_included: a.runs_included,
      active_jobs: a.active_jobs,
      active_jobs_limit: a.active_jobs_limit
    )
  end
end

#period ⇒ String

Returns The usage period this report covers, as YYYY-MM (UTC).

Returns:

  • (String) —

    The usage period this report covers, as YYYY-MM (UTC).



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/smplkit/jobs/models.rb', line 416

Usage = Struct.new(
  :period, :runs_used, :runs_included, :active_jobs, :active_jobs_limit,
  keyword_init: true
) do
  # @api private — Build a {Usage} snapshot from a JSON:API resource
  #   returned by the jobs service.
  #
  # @param resource [Object] The JSON:API resource (attributes).
  # @return [Usage] The usage snapshot.
  def self.from_resource(resource)
    a = resource.attributes
    new(
      period: a.period,
      runs_used: a.runs_used,
      runs_included: a.runs_included,
      active_jobs: a.active_jobs,
      active_jobs_limit: a.active_jobs_limit
    )
  end
end

#runs_included ⇒ Integer

Returns Runs included in the plan this period (-1 means unlimited).

Returns:

  • (Integer) —

    Runs included in the plan this period (-1 means unlimited).



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/smplkit/jobs/models.rb', line 416

Usage = Struct.new(
  :period, :runs_used, :runs_included, :active_jobs, :active_jobs_limit,
  keyword_init: true
) do
  # @api private — Build a {Usage} snapshot from a JSON:API resource
  #   returned by the jobs service.
  #
  # @param resource [Object] The JSON:API resource (attributes).
  # @return [Usage] The usage snapshot.
  def self.from_resource(resource)
    a = resource.attributes
    new(
      period: a.period,
      runs_used: a.runs_used,
      runs_included: a.runs_included,
      active_jobs: a.active_jobs,
      active_jobs_limit: a.active_jobs_limit
    )
  end
end

#runs_used ⇒ Integer

Returns Runs metered so far this period.

Returns:

  • (Integer) —

    Runs metered so far this period.



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/smplkit/jobs/models.rb', line 416

Usage = Struct.new(
  :period, :runs_used, :runs_included, :active_jobs, :active_jobs_limit,
  keyword_init: true
) do
  # @api private — Build a {Usage} snapshot from a JSON:API resource
  #   returned by the jobs service.
  #
  # @param resource [Object] The JSON:API resource (attributes).
  # @return [Usage] The usage snapshot.
  def self.from_resource(resource)
    a = resource.attributes
    new(
      period: a.period,
      runs_used: a.runs_used,
      runs_included: a.runs_included,
      active_jobs: a.active_jobs,
      active_jobs_limit: a.active_jobs_limit
    )
  end
end

Class Method Details

.from_resource(resource) ⇒ Usage

Returns The usage snapshot.

Parameters:

  • resource (Object) —

    The JSON:API resource (attributes).

Returns:

  • (Usage) —

    The usage snapshot.



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/smplkit/jobs/models.rb', line 425

def self.from_resource(resource)
  a = resource.attributes
  new(
    period: a.period,
    runs_used: a.runs_used,
    runs_included: a.runs_included,
    active_jobs: a.active_jobs,
    active_jobs_limit: a.active_jobs_limit
  )
end