Class: Smplkit::Jobs::Run

Inherits:

Struct

• Object
• Struct
• Smplkit::Jobs::Run

Defined in:

lib/smplkit/jobs/models.rb

Overview

A single execution of a job (read-only).

Runs are created and mutated by the jobs service, not by clients; clients influence runs only through the run / cancel / rerun actions on mgmt.jobs.

Instance Attribute Summary

• #created_at ⇒ String^?

  When the run was enqueued (became PENDING).

• #error ⇒ String^?

  Free-text failure detail, if any.

• #failure_reason ⇒ String^?

  Why a FAILED run failed; nil otherwise.

• #finished_at ⇒ String^?

  When execution finished.

• #id ⇒ String

  Server-assigned UUID for this run.

• #job ⇒ String

  The id of the job this run belongs to.

• #job_version ⇒ Integer^?

  The job’s version at the time the run executed.

• #pending_duration_ms ⇒ Integer^?

  Milliseconds the run waited as PENDING before starting.

• #request ⇒ Hash^?

  Snapshot of the request that was sent (header values redacted).

• #rerun_of ⇒ String^?

  The source run’s id; set only when trigger is RERUN.

• #result ⇒ Hash^?

  Outcome of the call (status, headers, body, …).

• #run_duration_ms ⇒ Integer^?

  Milliseconds the run spent executing.

• #scheduled_for ⇒ String^?

  The intended fire time for a scheduled run; nil for manual / rerun runs.

• #started_at ⇒ String^?

  When execution started.

• #status ⇒ String

  Lifecycle state of the run.

• #total_duration_ms ⇒ Integer^?

  Milliseconds from enqueue to finish.

• #trigger ⇒ String

  Why the run exists: SCHEDULE, MANUAL (run now), or RERUN.

Class Method Summary

• .from_resource(resource) ⇒ Object

Instance Attribute Details

#created_at ⇒ String^?

Returns When the run was enqueued (became PENDING).

Returns:

• (String, nil) —

  When the run was enqueued (became PENDING).

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#error ⇒ String^?

Returns Free-text failure detail, if any.

Returns:

• (String, nil) —

  Free-text failure detail, if any.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#failure_reason ⇒ String^?

Returns Why a FAILED run failed; nil otherwise.

Returns:

• (String, nil) —

  Why a FAILED run failed; nil otherwise.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#finished_at ⇒ String^?

Returns When execution finished.

Returns:

• (String, nil) —

  When execution finished.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#id ⇒ String

Returns Server-assigned UUID for this run.

Returns:

• (String) —

  Server-assigned UUID for this run.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#job ⇒ String

Returns The id of the job this run belongs to.

Returns:

• (String) —

  The id of the job this run belongs to.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#job_version ⇒ Integer^?

Returns The job’s version at the time the run executed.

Returns:

• (Integer, nil) —

  The job’s version at the time the run executed.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#pending_duration_ms ⇒ Integer^?

Returns Milliseconds the run waited as PENDING before starting.

Returns:

• (Integer, nil) —

  Milliseconds the run waited as PENDING before starting.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#request ⇒ Hash^?

Returns Snapshot of the request that was sent (header values redacted).

Returns:

• (Hash, nil) —

  Snapshot of the request that was sent (header values redacted).

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#rerun_of ⇒ String^?

Returns The source run’s id; set only when trigger is RERUN.

Returns:

• (String, nil) —

  The source run’s id; set only when trigger is RERUN.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#result ⇒ Hash^?

Returns Outcome of the call (status, headers, body, …).

Returns:

• (Hash, nil) —

  Outcome of the call (status, headers, body, …).

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#run_duration_ms ⇒ Integer^?

Returns Milliseconds the run spent executing.

Returns:

• (Integer, nil) —

  Milliseconds the run spent executing.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#scheduled_for ⇒ String^?

Returns The intended fire time for a scheduled run; nil for manual / rerun runs.

Returns:

• (String, nil) —

  The intended fire time for a scheduled run; nil for manual / rerun runs.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#started_at ⇒ String^?

Returns When execution started.

Returns:

• (String, nil) —

  When execution started.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#status ⇒ String

Returns Lifecycle state of the run.

Returns:

• (String) —

  Lifecycle state of the run.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#total_duration_ms ⇒ Integer^?

Returns Milliseconds from enqueue to finish.

Returns:

• (Integer, nil) —

  Milliseconds from enqueue to finish.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

#trigger ⇒ String

Returns Why the run exists: SCHEDULE, MANUAL (run now), or RERUN.

Returns:

• (String) —

  Why the run exists: SCHEDULE, MANUAL (run now), or RERUN.

# File 'lib/smplkit/jobs/models.rb', line 350

Run = Struct.new(
  :id, :job, :job_version, :trigger, :rerun_of, :scheduled_for, :status,
  :started_at, :finished_at, :pending_duration_ms, :run_duration_ms,
  :total_duration_ms, :failure_reason, :error, :request, :result, :created_at,
  keyword_init: true
) do
  def self.from_resource(resource)
    a = resource.attributes
    new(
      id: resource.id,
      job: a.job,
      job_version: a.job_version,
      trigger: a.trigger,
      rerun_of: a.rerun_of,
      scheduled_for: a.scheduled_for,
      status: a.status,
      started_at: a.started_at,
      finished_at: a.finished_at,
      pending_duration_ms: a.pending_duration_ms,
      run_duration_ms: a.run_duration_ms,
      total_duration_ms: a.total_duration_ms,
      failure_reason: a.failure_reason,
      error: a.error,
      request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
      result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
      created_at: a.created_at
    )
  end
end

Class Method Details

.from_resource(resource) ⇒ Object

# File 'lib/smplkit/jobs/models.rb', line 356

def self.from_resource(resource)
  a = resource.attributes
  new(
    id: resource.id,
    job: a.job,
    job_version: a.job_version,
    trigger: a.trigger,
    rerun_of: a.rerun_of,
    scheduled_for: a.scheduled_for,
    status: a.status,
    started_at: a.started_at,
    finished_at: a.finished_at,
    pending_duration_ms: a.pending_duration_ms,
    run_duration_ms: a.run_duration_ms,
    total_duration_ms: a.total_duration_ms,
    failure_reason: a.failure_reason,
    error: a.error,
    request: a.request.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.request),
    result: a.result.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.result),
    created_at: a.created_at
  )
end