Package com.circleci.client.v2.api

Class WorkflowApi

java.lang.Object

com.circleci.client.v2.api.WorkflowApi

public class WorkflowApi
extends Object

Constructor Summary

Constructors

Constructor	Description
WorkflowApi()
WorkflowApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
MessageResponse	cancelWorkflow(UUID id)	Cancel a workflow Cancels a running workflow.
ApiResponse<MessageResponse>	cancelWorkflowWithHttpInfo(UUID id)	Cancel a workflow Cancels a running workflow.
ApiClient	getApiClient()
Workflow	getWorkflowById(UUID id)	Get a workflow Returns summary fields of a workflow by ID.
ApiResponse<Workflow>	getWorkflowByIdWithHttpInfo(UUID id)	Get a workflow Returns summary fields of a workflow by ID.
WorkflowJobListResponse	listWorkflowJobs(UUID id)	Get a workflow's jobs Returns a sequence of jobs for a workflow.
ApiResponse<WorkflowJobListResponse>	listWorkflowJobsWithHttpInfo(UUID id)	Get a workflow's jobs Returns a sequence of jobs for a workflow.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowApi

public WorkflowApi()

WorkflowApi

public WorkflowApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cancelWorkflow

public MessageResponse cancelWorkflow(UUID id)
                               throws ApiException

Cancel a workflow Cancels a running workflow.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

MessageResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	A confirmation message.	-

cancelWorkflowWithHttpInfo

public ApiResponse<MessageResponse> cancelWorkflowWithHttpInfo(UUID id)
                                                        throws ApiException

Cancel a workflow Cancels a running workflow.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

ApiResponse<MessageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202	A confirmation message.	-

getWorkflowById

public Workflow getWorkflowById(UUID id)
                         throws ApiException

Get a workflow Returns summary fields of a workflow by ID.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

Workflow

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A workflow object.	-

getWorkflowByIdWithHttpInfo

public ApiResponse<Workflow> getWorkflowByIdWithHttpInfo(UUID id)
                                                  throws ApiException

Get a workflow Returns summary fields of a workflow by ID.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

ApiResponse<Workflow>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A workflow object.	-

listWorkflowJobs

public WorkflowJobListResponse listWorkflowJobs(UUID id)
                                         throws ApiException

Get a workflow's jobs Returns a sequence of jobs for a workflow.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

WorkflowJobListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated sequence of jobs.	-

listWorkflowJobsWithHttpInfo

public ApiResponse<WorkflowJobListResponse> listWorkflowJobsWithHttpInfo(UUID id)
                                                                  throws ApiException

Get a workflow's jobs Returns a sequence of jobs for a workflow.

Parameters:

id - The unique ID of the workflow. (required)

Returns:

ApiResponse<WorkflowJobListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated sequence of jobs.	-