Class PipelineRunImpl

Package version

Class representing a PipelineRun.

Hierarchy

PipelineRunImpl

Implements

PipelineRun

Index

Constructors

constructor

Methods

Constructors

constructor

new PipelineRunImpl(client: ArtifactsClientContext): PipelineRunImpl

- Defined in operations/pipelineRun.ts:26
Initialize a new instance of the class PipelineRun class.

Parameters
- client: ArtifactsClientContext
  
  Reference to the service client
Returns PipelineRunImpl

Methods

cancelPipelineRun

cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<coreHttp.RestResponse>

- Defined in operations/pipelineRun.ts:143
Cancel a pipeline run by its run ID.

Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: PipelineRunCancelPipelineRunOptionalParams
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

getPipelineRun

getPipelineRun(runId: string, options?: coreHttp.OperationOptions): Promise<PipelineRunGetPipelineRunResponse>

- Defined in operations/pipelineRun.ts:75
Get a pipeline run by its run ID.

Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<PipelineRunGetPipelineRunResponse>

queryActivityRuns

queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: coreHttp.OperationOptions): Promise<PipelineRunQueryActivityRunsResponse>

- Defined in operations/pipelineRun.ts:108
Query activity runs based on input filter conditions.

Parameters
- pipelineName: string
  
  The pipeline name.
- runId: string
  
  The pipeline run identifier.
- filterParameters: RunFilterParameters
  
  Parameters to filter the activity runs.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<PipelineRunQueryActivityRunsResponse>

queryPipelineRunsByWorkspace

queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: coreHttp.OperationOptions): Promise<PipelineRunQueryPipelineRunsByWorkspaceResponse>

- Defined in operations/pipelineRun.ts:41
Query pipeline runs in the workspace based on input filter conditions.

Parameters
- filterParameters: RunFilterParameters
  
  Parameters to filter the pipeline run.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<PipelineRunQueryPipelineRunsByWorkspaceResponse>

Generated using TypeDoc