Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JobExecutionData

Data about a job execution.

Hierarchy

  • JobExecutionData

Index

Properties

Optional executionNumber

executionNumber: undefined | number

A number that identifies a job execution on a device. It can be used later in commands that return or update job execution information.

Optional jobDocument

jobDocument: undefined | object

The content of the job document.

Optional jobId

jobId: undefined | string

The unique identifier you assigned to this job when it was created.

Optional lastUpdatedAt

lastUpdatedAt: Date

The time when the job execution started.

Optional queuedAt

queuedAt: Date

The time when the job execution was enqueued.

Optional startedAt

startedAt: Date

The time when the job execution started.

Optional status

status: JobStatus

The status of the job execution. Can be one of: QUEUED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELED, TIMED_OUT, REJECTED, or REMOVED.

Optional statusDetails

statusDetails: undefined | {}

A collection of name-value pairs that describe the status of the job execution.

Optional thingName

thingName: undefined | string

The name of the thing that is executing the job.

Optional versionNumber

versionNumber: undefined | number

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

Generated using TypeDoc