Package version:

Interface PipelineRunOperations

Interface representing a PipelineRunOperations.

Hierarchy

PipelineRunOperations

Index

Methods

cancelPipelineRun getPipelineRun queryActivityRuns queryPipelineRunsByWorkspace

Methods

cancelPipelineRun

cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<void>
Cancel a pipeline run by its run ID.
Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: PipelineRunCancelPipelineRunOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/pipelineRunOperations.ts:58

getPipelineRun

getPipelineRun(runId: string, options?: PipelineRunGetPipelineRunOptionalParams): Promise<PipelineRun>
Get a pipeline run by its run ID.
Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: PipelineRunGetPipelineRunOptionalParams
  
  The options parameters.
Returns Promise<PipelineRun>
- Defined in operationsInterfaces/pipelineRunOperations.ts:36

queryActivityRuns

queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: PipelineRunQueryActivityRunsOptionalParams): Promise<ActivityRunsQueryResponse>
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: PipelineRunQueryActivityRunsOptionalParams
  
  The options parameters.
Returns Promise<ActivityRunsQueryResponse>
- Defined in operationsInterfaces/pipelineRunOperations.ts:47

queryPipelineRunsByWorkspace

queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams): Promise<PipelineRunsQueryResponse>
Query pipeline runs in the workspace based on input filter conditions.
Parameters
- filterParameters: RunFilterParameters
  
  Parameters to filter the pipeline run.
- Optional options: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<PipelineRunsQueryResponse>
- Defined in operationsInterfaces/pipelineRunOperations.ts:27

Generated using TypeDoc