Package com.circleci.client.v2.api

Class JobApi

java.lang.Object

com.circleci.client.v2.api.JobApi

public class JobApi
extends Object

Constructor Summary

Constructors

Constructor	Description
JobApi()
JobApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
MessageResponse	cancelJob(Object jobNumber, String projectSlug)	Cancel job Cancel job with a given job number.
ApiResponse<MessageResponse>	cancelJobWithHttpInfo(Object jobNumber, String projectSlug)	Cancel job Cancel job with a given job number.
ApiClient	getApiClient()
ArtifactListResponse	getJobArtifacts(Object jobNumber, String projectSlug)	Get a job's artifacts Returns a job's artifacts.
ApiResponse<ArtifactListResponse>	getJobArtifactsWithHttpInfo(Object jobNumber, String projectSlug)	Get a job's artifacts Returns a job's artifacts.
JobDetails	getJobDetails(Object jobNumber, String projectSlug)	Get job details Returns job details.
ApiResponse<JobDetails>	getJobDetailsWithHttpInfo(Object jobNumber, String projectSlug)	Get job details Returns job details.
TestsResponse	getTests(Object jobNumber, String projectSlug)	Get test metadata Get test metadata for a build.
ApiResponse<TestsResponse>	getTestsWithHttpInfo(Object jobNumber, String projectSlug)	Get test metadata Get test metadata for a build.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobApi

public JobApi()

JobApi

public JobApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

cancelJob

public MessageResponse cancelJob(Object jobNumber,
                                 String projectSlug)
                          throws ApiException

Cancel job Cancel job with a given job number.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

MessageResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202		-

cancelJobWithHttpInfo

public ApiResponse<MessageResponse> cancelJobWithHttpInfo(Object jobNumber,
                                                          String projectSlug)
                                                   throws ApiException

Cancel job Cancel job with a given job number.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

ApiResponse<MessageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
202		-

getJobArtifacts

public ArtifactListResponse getJobArtifacts(Object jobNumber,
                                            String projectSlug)
                                     throws ApiException

Get a job's artifacts Returns a job's artifacts.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

ArtifactListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated list of the job's artifacts.	-

getJobArtifactsWithHttpInfo

public ApiResponse<ArtifactListResponse> getJobArtifactsWithHttpInfo(Object jobNumber,
                                                                     String projectSlug)
                                                              throws ApiException

Get a job's artifacts Returns a job's artifacts.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

ApiResponse<ArtifactListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated list of the job's artifacts.	-

getJobDetails

public JobDetails getJobDetails(Object jobNumber,
                                String projectSlug)
                         throws ApiException

Get job details Returns job details.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

JobDetails

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	Job details.	-

getJobDetailsWithHttpInfo

public ApiResponse<JobDetails> getJobDetailsWithHttpInfo(Object jobNumber,
                                                         String projectSlug)
                                                  throws ApiException

Get job details Returns job details.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

ApiResponse<JobDetails>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	Job details.	-

getTests

public TestsResponse getTests(Object jobNumber,
                              String projectSlug)
                       throws ApiException

Get test metadata Get test metadata for a build.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

TestsResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated list of test results.	-

getTestsWithHttpInfo

public ApiResponse<TestsResponse> getTestsWithHttpInfo(Object jobNumber,
                                                       String projectSlug)
                                                throws ApiException

Get test metadata Get test metadata for a build.

Parameters:

jobNumber - The number of the job. (required)

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

Returns:

ApiResponse<TestsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A paginated list of test results.	-