Edit

Share via

TimelineRecord interface

  • Reference
Package:
azure-devops-extension-api

Detailed information about the execution of different operations during pipeline run.

Properties

agentSpecification

The specification of an agent running a pipeline job, in binary format. Applicable when record is of type Job. <br />Example: { "VMImage" : "windows-2019" }
attempt

The number of record attempts.
changeId

The ID connecting all records updated at the same time. This value is taken from timeline's ChangeId.
currentOperation

A string that indicates the current operation.
details

A reference to a sub-timeline.
errorCount

The number of errors produced by this operation.
finishTime

The finish time of the record.
id

The ID of the record.
identifier

String identifier that is consistent across attempts.
issues

The list of issues produced by this operation.
lastModified

The time the record was last modified.
location

The REST URL of the record.
log

A reference to the log produced by this operation.
name

The name of the record.
order

An ordinal value relative to other records within the timeline.
parentId

The ID of the record's parent. <br />Example: Stage is a parent of a Phase, Phase is a parent of a Job, Job is a parent of a Task.
percentComplete

The percentage of record completion.
previousAttempts

The previous record attempts.
queueId

The ID of the queue which connects projects to agent pools on which the operation ran on. Applicable when record is of type Job.
refName

Name of the referenced record.
result

The result of the record.
resultCode

Evaluation of predefined conditions upon completion of record's operation. <br />Example: Evaluating succeeded(), Result = True <br />Example: Evaluating and(succeeded(), eq(variables['system.debug'], False)), Result = False
startTime

The start time of the record.
state

The state of the record.
task

A reference to the task. Applicable when record is of type Task.
type

The type of operation being tracked by the record. <br />Example: Stage, Phase, Job, Task...
variables

The variables of the record.
warningCount

The number of warnings produced by this operation.
workerName

The name of the agent running the operation. Applicable when record is of type Job.

Property Details

agentSpecification

The specification of an agent running a pipeline job, in binary format. Applicable when record is of type Job. <br />Example: { "VMImage" : "windows-2019" }

agentSpecification: any

Property Value

any

attempt

The number of record attempts.

attempt: number

Property Value

number

changeId

The ID connecting all records updated at the same time. This value is taken from timeline's ChangeId.

changeId: number

Property Value

number

currentOperation

A string that indicates the current operation.

currentOperation: string

Property Value

string

details

A reference to a sub-timeline.

details: TimelineReference

Property Value

TimelineReference

errorCount

The number of errors produced by this operation.

errorCount: number

Property Value

number

finishTime

The finish time of the record.

finishTime: Date

Property Value

Date

id

The ID of the record.

id: string

Property Value

string

identifier

String identifier that is consistent across attempts.

identifier: string

Property Value

string

issues

The list of issues produced by this operation.

issues: Issue[]

Property Value

Issue[]

lastModified

The time the record was last modified.

lastModified: Date

Property Value

Date

location

The REST URL of the record.

location: string

Property Value

string

log

A reference to the log produced by this operation.

log: TaskLogReference

Property Value

TaskLogReference

name

The name of the record.

name: string

Property Value

string

order

An ordinal value relative to other records within the timeline.

order: number

Property Value

number

parentId

The ID of the record's parent. <br />Example: Stage is a parent of a Phase, Phase is a parent of a Job, Job is a parent of a Task.

parentId: string

Property Value

string

percentComplete

The percentage of record completion.

percentComplete: number

Property Value

number

previousAttempts

The previous record attempts.

previousAttempts: TimelineAttempt[]

Property Value

TimelineAttempt[]

queueId

The ID of the queue which connects projects to agent pools on which the operation ran on. Applicable when record is of type Job.

queueId: number

Property Value

number

refName

Name of the referenced record.

refName: string

Property Value

string

result

The result of the record.

result: TaskResult

Property Value

TaskResult

resultCode

Evaluation of predefined conditions upon completion of record's operation. <br />Example: Evaluating succeeded(), Result = True <br />Example: Evaluating and(succeeded(), eq(variables['system.debug'], False)), Result = False

resultCode: string

Property Value

string

startTime

The start time of the record.

startTime: Date

Property Value

Date

state

The state of the record.

state: TimelineRecordState

Property Value

TimelineRecordState

task

A reference to the task. Applicable when record is of type Task.

task: TaskReference

Property Value

TaskReference

type

The type of operation being tracked by the record. <br />Example: Stage, Phase, Job, Task...

type: string

Property Value

string

variables

The variables of the record.

variables: {[key: string]: VariableValue}

Property Value

{[key: string]: VariableValue}

warningCount

The number of warnings produced by this operation.

warningCount: number

Property Value

number

workerName

The name of the agent running the operation. Applicable when record is of type Job.

workerName: string

Property Value

string