Interface IPipelinesApi

interface IPipelinesApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createPipeline(
        inputParameters: CreatePipelineParameters,
        project: string,
    ): Promise<Pipeline>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getArtifact(
        project: string,
        pipelineId: number,
        runId: number,
        artifactName: string,
        expand?: GetArtifactExpandOptions,
    ): Promise<Artifact>;
    getLog(
        project: string,
        pipelineId: number,
        runId: number,
        logId: number,
        expand?: GetLogExpandOptions,
    ): Promise<Log>;
    getPipeline(
        project: string,
        pipelineId: number,
        pipelineVersion?: number,
    ): Promise<Pipeline>;
    getRun(project: string, pipelineId: number, runId: number): Promise<Run>;
    listLogs(
        project: string,
        pipelineId: number,
        runId: number,
        expand?: GetLogExpandOptions,
    ): Promise<LogCollection>;
    listPipelines(
        project: string,
        orderBy?: string,
        top?: number,
        continuationToken?: string,
    ): Promise<Pipeline[]>;
    listRuns(project: string, pipelineId: number): Promise<Run[]>;
    preview(
        runParameters: RunPipelineParameters,
        project: string,
        pipelineId: number,
        pipelineVersion?: number,
    ): Promise<PreviewRun>;
    runPipeline(
        runParameters: RunPipelineParameters,
        project: string,
        pipelineId: number,
        pipelineVersion?: number,
    ): Promise<Run>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

createAcceptHeader createPipeline createRequestOptions formatResponse getArtifact getLog getPipeline getRun listLogs listPipelines listRuns preview runPipeline

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createPipeline

createRequestOptions

formatResponse

getArtifact

getLog

getPipeline

getRun

listLogs

listPipelines

listRuns

preview

runPipeline

Settings

Member Visibility

On This Page

Properties
Methods