Package com.circleci.client.v2.api
Class PreviewApi
- java.lang.Object
-
- com.circleci.client.v2.api.PreviewApi
-
public class PreviewApi extends Object
-
-
Constructor Summary
Constructors Constructor Description PreviewApi()PreviewApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessageResponsecancelJob(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.CheckoutKeycreateCheckoutKey(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.EnvironmentVariablePaircreateEnvVar(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.MessageResponsedeleteCheckoutKey(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.MessageResponsedeleteEnvVar(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.ApiClientgetApiClient()CheckoutKeygetCheckoutKey(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.UsergetCurrentUser()User Information Provides information about the user that is currently signed in.ApiResponse<User>getCurrentUserWithHttpInfo()User Information Provides information about the user that is currently signed in.EnvironmentVariablePairgetEnvVar(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.PipelineWithWorkflowsgetPipelineById(UUID pipelineId)Get a pipeline Returns a pipeline by ID.ApiResponse<PipelineWithWorkflows>getPipelineByIdWithHttpInfo(UUID pipelineId)Get a pipeline Returns a pipeline by ID.PipelineConfiggetPipelineConfigById(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.ProjectgetProjectBySlug(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.WorkflowgetWorkflowById(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.List<CheckoutKey>listCheckoutKeys(String projectSlug)Get all checkout keys Returns a sequence of checkout keys for `:project`.ApiResponse<List<CheckoutKey>>listCheckoutKeysWithHttpInfo(String projectSlug)Get all checkout keys Returns a sequence of checkout keys for `:project`.List<EnvironmentVariablePair>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<List<EnvironmentVariablePair>>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.PipelineListResponselistMyPipelines(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.PipelineListResponselistPipelinesForProject(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.WorkflowJobListResponselistWorkflowJobs(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.voidsetApiClient(ApiClient apiClient)PipelineLighttriggerPipeline(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.
-
-
-
Constructor Detail
-
PreviewApi
public PreviewApi()
-
PreviewApi
public PreviewApi(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 -
-
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 202 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 202 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. -
-
getCurrentUser
public User getCurrentUser() throws ApiException
User Information Provides information about the user that is currently signed in.- Returns:
- User
- Throws:
ApiException- if fails to make API call- Http Response Details:
Status Code Description Response Headers 200 User login information. -
-
getCurrentUserWithHttpInfo
public ApiResponse<User> getCurrentUserWithHttpInfo() throws ApiException
User Information Provides information about the user that is currently signed in.- Returns:
- ApiResponse<User>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Status Code Description Response Headers 200 User login information. -
-
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. -
-
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. -
-
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 -
-
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. -
-
listCheckoutKeys
public List<CheckoutKey> 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:
- List<CheckoutKey>
- 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<List<CheckoutKey>> 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<List<CheckoutKey>>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Status Code Description Response Headers 200 A sequence of checkout keys. -
-
listEnvVars
public List<EnvironmentVariablePair> 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:
- List<EnvironmentVariablePair>
- 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<List<EnvironmentVariablePair>> 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<List<EnvironmentVariablePair>>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Status Code Description Response Headers 200 A sequence of environment variables. -
-
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. -
-
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. -
-
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. -
-
-