Package com.circleci.client.v2.api

Class PipelineApi

java.lang.Object

com.circleci.client.v2.api.PipelineApi

public class PipelineApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PipelineApi()
PipelineApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
PipelineWithWorkflows	getPipelineById(UUID pipelineId)	Get a pipeline Returns a pipeline by ID.
ApiResponse<PipelineWithWorkflows>	getPipelineByIdWithHttpInfo(UUID pipelineId)	Get a pipeline Returns a pipeline by ID.
PipelineConfig	getPipelineConfigById(UUID pipelineId)	Get a pipeline's configuration Returns a pipeline's configuration by ID.
ApiResponse<PipelineConfig>	getPipelineConfigByIdWithHttpInfo(UUID pipelineId)	Get a pipeline's configuration Returns a pipeline's configuration by ID.
PipelineListResponse	listMyPipelines(String projectSlug, String pageToken)	Get your pipelines Returns a sequence of all pipelines for this project triggered by the user.
ApiResponse<PipelineListResponse>	listMyPipelinesWithHttpInfo(String projectSlug, String pageToken)	Get your pipelines Returns a sequence of all pipelines for this project triggered by the user.
PipelineListResponse	listPipelinesForProject(String projectSlug, String pageToken)	Get all pipelines Returns all pipelines for this project.
ApiResponse<PipelineListResponse>	listPipelinesForProjectWithHttpInfo(String projectSlug, String pageToken)	Get all pipelines Returns all pipelines for this project.
void	setApiClient(ApiClient apiClient)
PipelineLight	triggerPipeline(String projectSlug, TriggerPipelineParameters triggerPipelineParameters)	Trigger a new pipeline Triggers a new pipeline on the project.
ApiResponse<PipelineLight>	triggerPipelineWithHttpInfo(String projectSlug, TriggerPipelineParameters triggerPipelineParameters)	Trigger a new pipeline Triggers a new pipeline on the project.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineApi

public PipelineApi()

PipelineApi

public PipelineApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getPipelineById

public PipelineWithWorkflows getPipelineById(UUID pipelineId)
                                      throws ApiException

Get a pipeline Returns a pipeline by ID.

Parameters:

pipelineId - The unique ID of the pipeline. (required)

Returns:

PipelineWithWorkflows

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A pipeline object.	-

getPipelineByIdWithHttpInfo

public ApiResponse<PipelineWithWorkflows> getPipelineByIdWithHttpInfo(UUID pipelineId)
                                                               throws ApiException

Get a pipeline Returns a pipeline by ID.

Parameters:

pipelineId - The unique ID of the pipeline. (required)

Returns:

ApiResponse<PipelineWithWorkflows>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A pipeline object.	-

getPipelineConfigById

public PipelineConfig getPipelineConfigById(UUID pipelineId)
                                     throws ApiException

Get a pipeline's configuration Returns a pipeline's configuration by ID.

Parameters:

pipelineId - The unique ID of the pipeline. (required)

Returns:

PipelineConfig

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The configuration strings for the pipeline.	-

getPipelineConfigByIdWithHttpInfo

public ApiResponse<PipelineConfig> getPipelineConfigByIdWithHttpInfo(UUID pipelineId)
                                                              throws ApiException

Get a pipeline's configuration Returns a pipeline's configuration by ID.

Parameters:

pipelineId - The unique ID of the pipeline. (required)

Returns:

ApiResponse<PipelineConfig>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The configuration strings for the pipeline.	-

listMyPipelines

public PipelineListResponse listMyPipelines(String projectSlug,
                                            String pageToken)
                                     throws ApiException

Get your pipelines Returns a sequence of all pipelines for this project triggered by the user.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

pageToken - A token to retrieve the next page of results. (optional)

Returns:

PipelineListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of pipelines.	-

listMyPipelinesWithHttpInfo

public ApiResponse<PipelineListResponse> listMyPipelinesWithHttpInfo(String projectSlug,
                                                                     String pageToken)
                                                              throws ApiException

Get your pipelines Returns a sequence of all pipelines for this project triggered by the user.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

pageToken - A token to retrieve the next page of results. (optional)

Returns:

ApiResponse<PipelineListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of pipelines.	-

listPipelinesForProject

public PipelineListResponse listPipelinesForProject(String projectSlug,
                                                    String pageToken)
                                             throws ApiException

Get all pipelines Returns all pipelines for this project.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

pageToken - A token to retrieve the next page of results. (optional)

Returns:

PipelineListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	A sequence of pipelines.	-

listPipelinesForProjectWithHttpInfo

public ApiResponse<PipelineListResponse> listPipelinesForProjectWithHttpInfo(String projectSlug,
                                                                             String pageToken)
                                                                      throws ApiException

Get all pipelines Returns all pipelines for this project.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

pageToken - A token to retrieve the next page of results. (optional)

Returns:

ApiResponse<PipelineListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	A sequence of pipelines.	-

triggerPipeline

public PipelineLight triggerPipeline(String projectSlug,
                                     TriggerPipelineParameters triggerPipelineParameters)
                              throws ApiException

Trigger a new pipeline Triggers a new pipeline on the project.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

triggerPipelineParameters - (optional)

Returns:

PipelineLight

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	The created pipeline.	-

triggerPipelineWithHttpInfo

public ApiResponse<PipelineLight> triggerPipelineWithHttpInfo(String projectSlug,
                                                              TriggerPipelineParameters triggerPipelineParameters)
                                                       throws ApiException

Trigger a new pipeline Triggers a new pipeline on the project.

Parameters:

projectSlug - Project slug in the form `vcs-slug/org-name/repo-name`. The `/` characters may be URL-escaped. (required)

triggerPipelineParameters - (optional)

Returns:

ApiResponse<PipelineLight>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	The created pipeline.	-