Class TaskApi

Hierarchy (View Summary)

ClientApiBase
- TaskApi

Implements

ITaskApi

Constructors

constructor

new TaskApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): TaskApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns TaskApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:49

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

appendLogContent

appendLogContent(
    customHeaders: any,
    contentStream: ReadableStream,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    logId: number,
): Promise<TaskLog>
Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream.
Parameters
- customHeaders: any
- contentStream: ReadableStream
  Content to upload
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
  The ID of the plan.
- logId: number
  The ID of the log.
Returns Promise<TaskLog>
Implementation of ITaskApi.appendLogContent
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:577

appendTimelineRecordFeed

appendTimelineRecordFeed(
    lines: TimelineRecordFeedLinesWrapper,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
): Promise<void>
Append content to timeline record feed.
Parameters
- lines: TimelineRecordFeedLinesWrapper
  Content to be appended to the timeline record feed.
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
  ID of the plan.
- timelineId: string
  ID of the task's timeline.
- recordId: string
  ID of the timeline record.
Returns Promise<void>
Implementation of ITaskApi.appendTimelineRecordFeed
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:408

associateLog

associateLog(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    logId: number,
    serializedBlobId: string,
    lineCount: number,
): Promise<TaskLog>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- logId: number
- serializedBlobId: string
- lineCount: number
Returns Promise<TaskLog>
Implementation of ITaskApi.associateLog
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:633

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ITaskApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createAttachment

createAttachment(
    customHeaders: any,
    contentStream: ReadableStream,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    type: string,
    name: string,
): Promise<TaskAttachment>
Parameters
- customHeaders: any
- contentStream: ReadableStream
  Content to upload
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- type: string
- name: string
Returns Promise<TaskAttachment>
Implementation of ITaskApi.createAttachment
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:111

createAttachmentFromArtifact

createAttachmentFromArtifact(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    type: string,
    name: string,
    artifactHash: string,
    length: number,
): Promise<TaskAttachment>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- type: string
- name: string
- artifactHash: string
- length: number
Returns Promise<TaskAttachment>
Implementation of ITaskApi.createAttachmentFromArtifact
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:176

createLog

createLog(
    log: TaskLog,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
): Promise<TaskLog>
Create a log and connect it to a pipeline run's execution plan.
Parameters
- log: TaskLog
  An object that contains information about log's path.
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
  The ID of the plan.
Returns Promise<TaskLog>
Implementation of ITaskApi.createLog
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:697

createOidcToken

createOidcToken(
    claims: { [key: string]: string },
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    jobId: string,
    serviceConnectionId?: string,
): Promise<TaskHubOidcToken>
Parameters
- claims: { [key: string]: string }
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- jobId: string
- OptionalserviceConnectionId: string
Returns Promise<TaskHubOidcToken>
Implementation of ITaskApi.createOidcToken
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:891

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ITaskApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createTimeline

createTimeline(
    timeline: Timeline,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
): Promise<Timeline>
Parameters
- timeline: Timeline
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
Returns Promise<Timeline>
Implementation of ITaskApi.createTimeline
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1195

deleteTimeline

deleteTimeline(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
): Promise<void>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
Returns Promise<void>
Implementation of ITaskApi.deleteTimeline
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1242

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ITaskApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getAttachment

getAttachment(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    type: string,
    name: string,
): Promise<TaskAttachment>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- type: string
- name: string
Returns Promise<TaskAttachment>
Implementation of ITaskApi.getAttachment
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:247

getAttachmentContent

getAttachmentContent(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    type: string,
    name: string,
): Promise<ReadableStream>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- type: string
- name: string
Returns Promise<ReadableStream>
Implementation of ITaskApi.getAttachmentContent
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:304

getAttachments

getAttachments(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    type: string,
): Promise<TaskAttachment[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- type: string
Returns Promise<TaskAttachment[]>
Implementation of ITaskApi.getAttachments
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:352

getJobInstance

getJobInstance(
    scopeIdentifier: string,
    hubName: string,
    orchestrationId: string,
): Promise<TaskAgentJob>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- orchestrationId: string
Returns Promise<TaskAgentJob>
Implementation of ITaskApi.getJobInstance
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:528

getLines

getLines(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    recordId: string,
    stepId: string,
    endLine?: number,
    takeCount?: number,
    continuationToken?: string,
): Promise<TimelineRecordFeedLinesWrapper>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- recordId: string
- stepId: string
- OptionalendLine: number
- OptionaltakeCount: number
- OptionalcontinuationToken: string
Returns Promise<TimelineRecordFeedLinesWrapper>
Implementation of ITaskApi.getLines
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:464

getLog

getLog(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    logId: number,
    startLine?: number,
    endLine?: number,
): Promise<string[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- logId: number
- OptionalstartLine: number
- OptionalendLine: number
Returns Promise<string[]>
Implementation of ITaskApi.getLog
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:746

getLogs

getLogs(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
): Promise<TaskLog[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
Returns Promise<TaskLog[]>
Implementation of ITaskApi.getLogs
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:801

getPlan

getPlan(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
): Promise<TaskOrchestrationPlan>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
Returns Promise<TaskOrchestrationPlan>
Implementation of ITaskApi.getPlan
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1042

getPlanAttachments

getPlanAttachments(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    type: string,
): Promise<TaskAttachment[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- type: string
Returns Promise<TaskAttachment[]>
Implementation of ITaskApi.getPlanAttachments
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:59

getPlanGroupsQueueMetrics

getPlanGroupsQueueMetrics(
scopeIdentifier: string,
hubName: string,
): Promise<TaskOrchestrationPlanGroupsQueueMetrics[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
Returns Promise<TaskOrchestrationPlanGroupsQueueMetrics[]>
Implementation of ITaskApi.getPlanGroupsQueueMetrics
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:845

getQueuedPlanGroup

getQueuedPlanGroup(
    scopeIdentifier: string,
    hubName: string,
    planGroup: string,
): Promise<TaskOrchestrationQueuedPlanGroup>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planGroup: string
Returns Promise<TaskOrchestrationQueuedPlanGroup>
Implementation of ITaskApi.getQueuedPlanGroup
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:997

getQueuedPlanGroups

getQueuedPlanGroups(
    scopeIdentifier: string,
    hubName: string,
    statusFilter?: PlanGroupStatus,
    count?: number,
): Promise<TaskOrchestrationQueuedPlanGroup[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- OptionalstatusFilter: PlanGroupStatus
- Optionalcount: number
Returns Promise<TaskOrchestrationQueuedPlanGroup[]>
Implementation of ITaskApi.getQueuedPlanGroups
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:946

getRecords

getRecords(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    changeId?: number,
): Promise<TimelineRecord[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- OptionalchangeId: number
Returns Promise<TimelineRecord[]>
Implementation of ITaskApi.getRecords
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1089

getTimeline

getTimeline(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
    changeId?: number,
    includeRecords?: boolean,
): Promise<Timeline>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
- timelineId: string
- OptionalchangeId: number
- OptionalincludeRecords: boolean
Returns Promise<Timeline>
Implementation of ITaskApi.getTimeline
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1292

getTimelines

getTimelines(
    scopeIdentifier: string,
    hubName: string,
    planId: string,
): Promise<Timeline[]>
Parameters
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
Returns Promise<Timeline[]>
Implementation of ITaskApi.getTimelines
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1347

updateRecords

updateRecords(
    records: VssJsonCollectionWrapperV<TimelineRecord[]>,
    scopeIdentifier: string,
    hubName: string,
    planId: string,
    timelineId: string,
): Promise<TimelineRecord[]>
Update timeline records if they already exist, otherwise create new ones for the same timeline.
Parameters
- records: VssJsonCollectionWrapperV<TimelineRecord[]>
  The array of timeline records to be updated.
- scopeIdentifier: string
  The project GUID to scope the request
- hubName: string
  The name of the server hub. Common examples: "build", "rm", "checks"
- planId: string
  The ID of the plan.
- timelineId: string
  The ID of the timeline.
Returns Promise<TimelineRecord[]>
Implementation of ITaskApi.updateRecords
- Defined in repos/azure-devops-node-api/api/TaskApi.ts:1146

Class TaskApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TaskApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

appendLogContent

Parameters

Returns Promise<TaskLog>

appendTimelineRecordFeed

Parameters

Returns Promise<void>

associateLog

Parameters

Returns Promise<TaskLog>

createAcceptHeader

Parameters

Returns string

createAttachment

Parameters

Returns Promise<TaskAttachment>

createAttachmentFromArtifact

Parameters

Returns Promise<TaskAttachment>

createLog

Parameters

Returns Promise<TaskLog>

createOidcToken

Parameters

Returns Promise<TaskHubOidcToken>

createRequestOptions

Parameters

Returns IRequestOptions

createTimeline

Parameters

Returns Promise<Timeline>

deleteTimeline

Parameters

Returns Promise<void>

formatResponse

Parameters

Returns any

getAttachment

Parameters

Returns Promise<TaskAttachment>

getAttachmentContent

Parameters

Returns Promise<ReadableStream>

getAttachments

Parameters

Returns Promise<TaskAttachment[]>

getJobInstance

Parameters

Returns Promise<TaskAgentJob>

getLines

Parameters

Returns Promise<TimelineRecordFeedLinesWrapper>

getLog

Parameters

Returns Promise<string[]>

getLogs

Parameters

Returns Promise<TaskLog[]>

getPlan

Parameters

Returns Promise<TaskOrchestrationPlan>

getPlanAttachments

Parameters