Package com.circleci.client.v2.api

Class DefaultApi

java.lang.Object

com.circleci.client.v2.api.DefaultApi

public class DefaultApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DefaultApi()
DefaultApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
List<Collaboration>	getCollaborations()	The set of organziations for which a user is a member or a collaborator.
ApiResponse<List<Collaboration>>	getCollaborationsWithHttpInfo()	The set of organziations for which a user is a member or a collaborator.
JobDetails	getJobDetails(Object jobNumber, String projectSlug)	Get job details.
ApiResponse<JobDetails>	getJobDetailsWithHttpInfo(Object jobNumber, String projectSlug)	Get job details.
TestsResponse	getTests(Object jobNumber, String projectSlug)	Get test metadata.
ApiResponse<TestsResponse>	getTestsWithHttpInfo(Object jobNumber, String projectSlug)	Get test metadata.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultApi

public DefaultApi()

DefaultApi

public DefaultApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCollaborations

public List<Collaboration> getCollaborations()
                                      throws ApiException

The set of organziations for which a user is a member or a collaborator. Provides all collaborations which are organizations including 1) orgs that the current user belongs to (BB & GH), 2) orgs that they do not belong to but they collaborate on repos (BB & GH), and 3) current user's account

Returns:

List<Collaboration>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	Collaborations	-

getCollaborationsWithHttpInfo

public ApiResponse<List<Collaboration>> getCollaborationsWithHttpInfo()
                                                               throws ApiException

The set of organziations for which a user is a member or a collaborator. Provides all collaborations which are organizations including 1) orgs that the current user belongs to (BB & GH), 2) orgs that they do not belong to but they collaborate on repos (BB & GH), and 3) current user's account

Returns:

ApiResponse<List<Collaboration>>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	Collaborations	-

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	the test results, paginated.	-

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	the test results, paginated.	-