Package com.circleci.client.v2.api

Class ProjectApi

java.lang.Object

com.circleci.client.v2.api.ProjectApi

public class ProjectApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ProjectApi()
ProjectApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CheckoutKey	createCheckoutKey(String projectSlug, CheckoutKeyInput checkoutKeyInput)	Create a new checkout key Creates a new checkout key.
ApiResponse<CheckoutKey>	createCheckoutKeyWithHttpInfo(String projectSlug, CheckoutKeyInput checkoutKeyInput)	Create a new checkout key Creates a new checkout key.
EnvironmentVariablePair	createEnvVar(String projectSlug, EnvironmentVariablePair1 environmentVariablePair1)	Create an environment variable Creates a new environment variable.
ApiResponse<EnvironmentVariablePair>	createEnvVarWithHttpInfo(String projectSlug, EnvironmentVariablePair1 environmentVariablePair1)	Create an environment variable Creates a new environment variable.
MessageResponse	deleteCheckoutKey(String projectSlug, String fingerprint)	Delete a checkout key Deletes the checkout key.
ApiResponse<MessageResponse>	deleteCheckoutKeyWithHttpInfo(String projectSlug, String fingerprint)	Delete a checkout key Deletes the checkout key.
MessageResponse	deleteEnvVar(String projectSlug, String name)	Delete an environment variable Deletes the environment variable named :name.
ApiResponse<MessageResponse>	deleteEnvVarWithHttpInfo(String projectSlug, String name)	Delete an environment variable Deletes the environment variable named :name.
ApiClient	getApiClient()
CheckoutKey	getCheckoutKey(String projectSlug, String fingerprint)	Get a checkout key Returns an individual checkout key.
ApiResponse<CheckoutKey>	getCheckoutKeyWithHttpInfo(String projectSlug, String fingerprint)	Get a checkout key Returns an individual checkout key.
EnvironmentVariablePair	getEnvVar(String projectSlug, String name)	Get masked environment variables Returns the masked value of environment variable :name.
ApiResponse<EnvironmentVariablePair>	getEnvVarWithHttpInfo(String projectSlug, String name)	Get masked environment variables Returns the masked value of environment variable :name.
Project	getProjectBySlug(String projectSlug)	Get a project Retrieves a project by project slug.
ApiResponse<Project>	getProjectBySlugWithHttpInfo(String projectSlug)	Get a project Retrieves a project by project slug.
CheckoutKeyListResponse	listCheckoutKeys(String projectSlug)	Get all checkout keys Returns a sequence of checkout keys for `:project`.
ApiResponse<CheckoutKeyListResponse>	listCheckoutKeysWithHttpInfo(String projectSlug)	Get all checkout keys Returns a sequence of checkout keys for `:project`.
EnvironmentVariableListResponse	listEnvVars(String projectSlug)	Get an environment variable Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.
ApiResponse<EnvironmentVariableListResponse>	listEnvVarsWithHttpInfo(String projectSlug)	Get an environment variable Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectApi

public ProjectApi()

ProjectApi

public ProjectApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCheckoutKey

public CheckoutKey createCheckoutKey(String projectSlug,
                                     CheckoutKeyInput checkoutKeyInput)
                              throws ApiException

Create a new checkout key Creates a new checkout key. This API request is only usable with a user API token.

Parameters:

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

checkoutKeyInput - (optional)

Returns:

CheckoutKey

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
201	The checkout key.	-

createCheckoutKeyWithHttpInfo

public ApiResponse<CheckoutKey> createCheckoutKeyWithHttpInfo(String projectSlug,
                                                              CheckoutKeyInput checkoutKeyInput)
                                                       throws ApiException

Create a new checkout key Creates a new checkout key. This API request is only usable with a user API token.

Parameters:

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

checkoutKeyInput - (optional)

Returns:

ApiResponse<CheckoutKey>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
201	The checkout key.	-

createEnvVar

public EnvironmentVariablePair createEnvVar(String projectSlug,
                                            EnvironmentVariablePair1 environmentVariablePair1)
                                     throws ApiException

Create an environment variable Creates a new environment variable.

Parameters:

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

environmentVariablePair1 - (optional)

Returns:

EnvironmentVariablePair

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
201	The environment variable.	-

createEnvVarWithHttpInfo

public ApiResponse<EnvironmentVariablePair> createEnvVarWithHttpInfo(String projectSlug,
                                                                     EnvironmentVariablePair1 environmentVariablePair1)
                                                              throws ApiException

Create an environment variable Creates a new environment variable.

Parameters:

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

environmentVariablePair1 - (optional)

Returns:

ApiResponse<EnvironmentVariablePair>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
201	The environment variable.	-

deleteCheckoutKey

public MessageResponse deleteCheckoutKey(String projectSlug,
                                         String fingerprint)
                                  throws ApiException

Delete a checkout key Deletes the checkout key.

Parameters:

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

fingerprint - An SSH key fingerprint. (required)

Returns:

MessageResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A confirmation message.	-

deleteCheckoutKeyWithHttpInfo

public ApiResponse<MessageResponse> deleteCheckoutKeyWithHttpInfo(String projectSlug,
                                                                  String fingerprint)
                                                           throws ApiException

Delete a checkout key Deletes the checkout key.

Parameters:

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

fingerprint - An SSH key fingerprint. (required)

Returns:

ApiResponse<MessageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A confirmation message.	-

deleteEnvVar

public MessageResponse deleteEnvVar(String projectSlug,
                                    String name)
                             throws ApiException

Delete an environment variable Deletes the environment variable named :name.

Parameters:

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

name - The name of the environment variable. (required)

Returns:

MessageResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A confirmation message.	-

deleteEnvVarWithHttpInfo

public ApiResponse<MessageResponse> deleteEnvVarWithHttpInfo(String projectSlug,
                                                             String name)
                                                      throws ApiException

Delete an environment variable Deletes the environment variable named :name.

Parameters:

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

name - The name of the environment variable. (required)

Returns:

ApiResponse<MessageResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A confirmation message.	-

getCheckoutKey

public CheckoutKey getCheckoutKey(String projectSlug,
                                  String fingerprint)
                           throws ApiException

Get a checkout key Returns an individual checkout key.

Parameters:

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

fingerprint - An SSH key fingerprint. (required)

Returns:

CheckoutKey

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The checkout key.	-

getCheckoutKeyWithHttpInfo

public ApiResponse<CheckoutKey> getCheckoutKeyWithHttpInfo(String projectSlug,
                                                           String fingerprint)
                                                    throws ApiException

Get a checkout key Returns an individual checkout key.

Parameters:

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

fingerprint - An SSH key fingerprint. (required)

Returns:

ApiResponse<CheckoutKey>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The checkout key.	-

getEnvVar

public EnvironmentVariablePair getEnvVar(String projectSlug,
                                         String name)
                                  throws ApiException

Get masked environment variables Returns the masked value of environment variable :name.

Parameters:

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

name - The name of the environment variable. (required)

Returns:

EnvironmentVariablePair

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The environment variable.	-

getEnvVarWithHttpInfo

public ApiResponse<EnvironmentVariablePair> getEnvVarWithHttpInfo(String projectSlug,
                                                                  String name)
                                                           throws ApiException

Get masked environment variables Returns the masked value of environment variable :name.

Parameters:

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

name - The name of the environment variable. (required)

Returns:

ApiResponse<EnvironmentVariablePair>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	The environment variable.	-

getProjectBySlug

public Project getProjectBySlug(String projectSlug)
                         throws ApiException

Get a project Retrieves a project by project slug.

Parameters:

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

Returns:

Project

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A project object	-

getProjectBySlugWithHttpInfo

public ApiResponse<Project> getProjectBySlugWithHttpInfo(String projectSlug)
                                                  throws ApiException

Get a project Retrieves a project by project slug.

Parameters:

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

Returns:

ApiResponse<Project>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A project object	-

listCheckoutKeys

public CheckoutKeyListResponse listCheckoutKeys(String projectSlug)
                                         throws ApiException

Get all checkout keys Returns a sequence of checkout keys for `:project`.

Parameters:

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

Returns:

CheckoutKeyListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of checkout keys.	-

listCheckoutKeysWithHttpInfo

public ApiResponse<CheckoutKeyListResponse> listCheckoutKeysWithHttpInfo(String projectSlug)
                                                                  throws ApiException

Get all checkout keys Returns a sequence of checkout keys for `:project`.

Parameters:

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

Returns:

ApiResponse<CheckoutKeyListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of checkout keys.	-

listEnvVars

public EnvironmentVariableListResponse listEnvVars(String projectSlug)
                                            throws ApiException

Get an environment variable Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.

Parameters:

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

Returns:

EnvironmentVariableListResponse

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of environment variables.	-

listEnvVarsWithHttpInfo

public ApiResponse<EnvironmentVariableListResponse> listEnvVarsWithHttpInfo(String projectSlug)
                                                                     throws ApiException

Get an environment variable Returns four 'x' characters, in addition to the last four ASCII characters of the value, consistent with the display of environment variable values on the CircleCI website.

Parameters:

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

Returns:

ApiResponse<EnvironmentVariableListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Status Code	Description	Response Headers
200	A sequence of environment variables.	-