Package org.azd.pipelines

Class PipelinesApi

java.lang.Object

org.azd.utils.AzDAsyncApi<PipelinesApi>

org.azd.pipelines.PipelinesApi

All Implemented Interfaces:

PipelinesDetails

public class PipelinesApi
extends AzDAsyncApi<PipelinesApi>
implements PipelinesDetails

PipelinesApi class to manage Pipelines API

Constructor Summary

Constructors

Constructor	Description
PipelinesApi(Connection connection)	Pass the connection object to work with Pipelines Api

Method Summary

Modifier and Type	Method	Description
Pipeline	createPipeline(String name, String folder, String pathOfYamlFile, String repositoryId, String repositoryName)	Create a pipeline.
PipelinesArtifact	getArtifacts(int pipelineId, int runId, String artifactName)	Get a specific artifact from a pipeline run
PipelinesArtifact	getArtifacts(int pipelineId, int runId, String artifactName, PipelinesExpandOptions expandOptions)	Get a specific artifact from a pipeline run
Pipeline	getPipeline(int pipelineId)	Gets a pipeline, optionally at the specified version
Pipeline	getPipeline(int pipelineId, String pipelineVersion)	Gets a pipeline, optionally at the specified version
PipelineLog	getPipelineLog(int pipelineId, int runId, int logId)	Get a specific log from a pipeline run
PipelineLog	getPipelineLog(int pipelineId, int runId, int logId, PipelinesExpandOptions expandOptions)	Get a specific log from a pipeline run
LogCollection	getPipelineLogs(int pipelineId, int runId)	Get a list of logs from a pipeline run.
LogCollection	getPipelineLogs(int pipelineId, int runId, PipelinesExpandOptions expandOptions)	Get a list of logs from a pipeline run.
PipelineRun	getPipelineRun(int pipelineId, int runId)	Gets a run for a particular pipeline.
PipelineRuns	getPipelineRuns(int pipelineId)	Gets top 10000 runs for a particular pipeline.
Pipelines	getPipelines()	Get a list of pipelines.
PreviewRun	previewPipeline(int pipelineId, boolean previewRun)	Queues a dry run of the pipeline and returns an object containing the final yaml.
PreviewRun	previewPipeline(int pipelineId, boolean previewRun, String yamlOverride)	Queues a dry run of the pipeline and returns an object containing the final yaml.
PipelineRun	runPipeline(int pipelineId)	Runs a pipeline.
PipelineRun	runPipeline(int pipelineId, Map pipelineRunParameters)	Runs a pipeline.

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipelinesApi

public PipelinesApi(Connection connection)

Pass the connection object to work with Pipelines Api

Parameters:

connection - Connection object

Method Details

getArtifacts

public PipelinesArtifact getArtifacts(int pipelineId,
 int runId,
 String artifactName)
                               throws AzDException

Get a specific artifact from a pipeline run

Specified by:

getArtifacts in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

artifactName - Name of the artifact.

Returns:

PipelinesArtifact object PipelinesArtifact

Throws:

AzDException - Default Api Exception handler.

getArtifacts

public PipelinesArtifact getArtifacts(int pipelineId,
 int runId,
 String artifactName,
 PipelinesExpandOptions expandOptions)
                               throws AzDException

Get a specific artifact from a pipeline run

Specified by:

getArtifacts in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

artifactName - Name of the artifact.

expandOptions - Expand options. Default is None. PipelinesExpandOptions

Returns:

PipelinesArtifact object PipelinesArtifact

Throws:

AzDException - Default Api Exception handler.

getPipelineLog

public PipelineLog getPipelineLog(int pipelineId,
 int runId,
 int logId)
                           throws AzDException

Get a specific log from a pipeline run

Specified by:

getPipelineLog in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

Returns:

PipelineLog object PipelineLog

Throws:

AzDException - Default Api Exception handler.

getPipelineLog

public PipelineLog getPipelineLog(int pipelineId,
 int runId,
 int logId,
 PipelinesExpandOptions expandOptions)
                           throws AzDException

Get a specific log from a pipeline run

Specified by:

getPipelineLog in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

logId - ID of the log.

expandOptions - Expand options. Default is None. PipelinesExpandOptions

Returns:

PipelineLog object PipelineLog

Throws:

AzDException - Default Api Exception handler.

getPipelineLogs

public LogCollection getPipelineLogs(int pipelineId,
 int runId)
                              throws AzDException

Get a list of logs from a pipeline run.

Specified by:

getPipelineLogs in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

Returns:

LogCollection object LogCollection

Throws:

AzDException - Default Api Exception handler.

getPipelineLogs

public LogCollection getPipelineLogs(int pipelineId,
 int runId,
 PipelinesExpandOptions expandOptions)
                              throws AzDException

Get a list of logs from a pipeline run.

Specified by:

getPipelineLogs in interface PipelinesDetails

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

expandOptions - Expand options. Default is None. PipelinesExpandOptions

Returns:

LogCollection object LogCollection

Throws:

AzDException - Default Api Exception handler.

createPipeline

public Pipeline createPipeline(String name,
 String folder,
 String pathOfYamlFile,
 String repositoryId,
 String repositoryName)
                        throws AzDException

Create a pipeline.

Specified by:

createPipeline in interface PipelinesDetails

Parameters:

name - Name of the pipeline.

folder - Folder of the pipeline.

pathOfYamlFile - Path of azure-pipelines.yaml file in the repository.

repositoryId - Id of the repository

repositoryName - Name of the repository

Returns:

Pipeline object Pipeline

Throws:

AzDException - Default Api Exception handler.

getPipeline

public Pipeline getPipeline(int pipelineId)
                     throws AzDException

Gets a pipeline, optionally at the specified version

Specified by:

getPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline ID

Returns:

Pipeline object Pipeline

Throws:

AzDException - Default Api Exception handler.

getPipeline

public Pipeline getPipeline(int pipelineId,
 String pipelineVersion)
                     throws AzDException

Gets a pipeline, optionally at the specified version

Specified by:

getPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline ID

pipelineVersion - The pipeline version

Returns:

Pipeline object Pipeline

Throws:

AzDException - Default Api Exception handler.

getPipelines

public Pipelines getPipelines()
                       throws AzDException

Get a list of pipelines.

Specified by:

getPipelines in interface PipelinesDetails

Returns:

Pipelines Pipelines

Throws:

AzDException - Default Api Exception handler.

previewPipeline

public PreviewRun previewPipeline(int pipelineId,
 boolean previewRun)
                           throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Specified by:

previewPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline ID.

previewRun - If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.

Returns:

PreviewRun object PreviewRun

Throws:

AzDException - Default Api Exception handler.

previewPipeline

public PreviewRun previewPipeline(int pipelineId,
 boolean previewRun,
 String yamlOverride)
                           throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Specified by:

previewPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline ID.

previewRun - If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.

yamlOverride - If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.

Returns:

PreviewRun object PreviewRun

Throws:

AzDException - Default Api Exception handler.

getPipelineRun

public PipelineRun getPipelineRun(int pipelineId,
 int runId)
                           throws AzDException

Gets a run for a particular pipeline.

Specified by:

getPipelineRun in interface PipelinesDetails

Parameters:

pipelineId - The pipeline id

runId - The run id

Returns:

Pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

getPipelineRuns

public PipelineRuns getPipelineRuns(int pipelineId)
                             throws AzDException

Gets top 10000 runs for a particular pipeline.

Specified by:

getPipelineRuns in interface PipelinesDetails

Parameters:

pipelineId - The pipeline id

Returns:

a list of pipeline run object PipelineRuns

Throws:

AzDException - Default Api Exception handler.

runPipeline

public PipelineRun runPipeline(int pipelineId)
                        throws AzDException

Runs a pipeline.

Specified by:

runPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline id

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

runPipeline

public PipelineRun runPipeline(int pipelineId,
 Map pipelineRunParameters)
                        throws AzDException

Runs a pipeline.

Specified by:

runPipeline in interface PipelinesDetails

Parameters:

pipelineId - The pipeline id

pipelineRunParameters - a map of request parameters.

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.