Interface JobExecutionData

Data about a job execution.

Hierarchy

  • JobExecutionData

Properties

executionNumber? jobDocument? jobId? lastUpdatedAt? queuedAt? startedAt? status? statusDetails? thingName? versionNumber?

Properties

Optional executionNumber

executionNumber?: 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?: object

The content of the job document.

Optional jobId

jobId?: 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?: {
    [key: string]: string;
}

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

Type declaration

  • [key: string]: string

Optional thingName

thingName?: string

The name of the thing that is executing the job.

Optional versionNumber

versionNumber?: number

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc