Edit

Share via

ItemJobInstance interface

Package:
@ms-fabric/workload-client

An interface representing single job instance

Properties

isSuccessful

Whether the job is successful
itemId

The numeric id of the item
itemJobInstanceId

The object id of the item job
itemJobType

The type of the item job
itemObjectId

The object id of the item
jobDefinitionObjectId

The object id of job definition that schedules this job instance.
jobEndTimeUtc

The utc timestamp of the job succeeded or failed
jobScheduleTimeUtc

The utc timestamp of the job is scheduled or triggered
jobStartTimeUtc

The utc timestamp of the job actually started, reported by workload
serviceExceptionJson

Exception with JSON format that is thrown when running this job instance. It could be throw by different services, users should not rely on its value which can be null even the job is failed.
status

The status of the item job
statusString

The string representation of status

Property Details

isSuccessful

Whether the job is successful

isSuccessful: boolean

Property Value

boolean

itemId

The numeric id of the item

itemId: number

Property Value

number

itemJobInstanceId

The object id of the item job

itemJobInstanceId: string

Property Value

string

itemJobType

The type of the item job

itemJobType: string

Property Value

string

itemObjectId

The object id of the item

itemObjectId: string

Property Value

string

jobDefinitionObjectId

The object id of job definition that schedules this job instance.

jobDefinitionObjectId?: string

Property Value

string

jobEndTimeUtc

The utc timestamp of the job succeeded or failed

jobEndTimeUtc: string

Property Value

string

jobScheduleTimeUtc

The utc timestamp of the job is scheduled or triggered

jobScheduleTimeUtc: string

Property Value

string

jobStartTimeUtc

The utc timestamp of the job actually started, reported by workload

jobStartTimeUtc: string

Property Value

string

serviceExceptionJson

Exception with JSON format that is thrown when running this job instance. It could be throw by different services, users should not rely on its value which can be null even the job is failed.

serviceExceptionJson?: string

Property Value

string

status

The status of the item job

status: ItemJobStatus | "NotStarted" | "InProgress" | "Completed" | "Failed" | "Cancelled" | "NotFound" | "Duplicate" | "OwnerUserMissing" | "DeadLettered" | "Unknown"

Property Value

ItemJobStatus | "NotStarted" | "InProgress" | "Completed" | "Failed" | "Cancelled" | "NotFound" | "Duplicate" | "OwnerUserMissing" | "DeadLettered" | "Unknown"

statusString

The string representation of status

statusString: string

Property Value

string