Package com.circleci.client.v2.api

Class DefaultApi

  • public class DefaultApi
extends Object

    • Constructor Detail

      • DefaultApi

        public DefaultApi()

      • DefaultApi

        public DefaultApi​(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 -

      • 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. -

      • 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. -

      • getCollaborations

        public List<Collaboration> getCollaborations()
                                      throws ApiException
        Collaborations Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the 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
        Collaborations Provides the set of organizations of which a user is a member or a collaborator. The set of organizations that a user can collaborate on is composed of: * Organizations that the current user belongs to across VCS types (e.g. BitBucket, GitHub) * The parent organization of repository that the user can collaborate on, but is not necessarily a member of * The organization of the 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 -

      • 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 a masked environment variable 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 a masked environment variable 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. -

      • 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. -

      • getPipelineById

        public Pipeline getPipelineById​(UUID pipelineId)
                         throws ApiException
        Get a pipeline Returns a pipeline by ID.
        Parameters:
        pipelineId - The unique ID of the pipeline. (required)
        Returns:
        Pipeline
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        200 A pipeline object. -

      • getPipelineByIdWithHttpInfo

        public ApiResponse<Pipeline> getPipelineByIdWithHttpInfo​(UUID pipelineId)
                                                  throws ApiException
        Get a pipeline Returns a pipeline by ID.
        Parameters:
        pipelineId - The unique ID of the pipeline. (required)
        Returns:
        ApiResponse<Pipeline>
        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 -

      • 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. -

      • getUser

        public User getUser​(UUID id)
             throws ApiException
        User Information Provides information about the user with the given ID.
        Parameters:
        id - The unique ID of the user. (required)
        Returns:
        User
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        200 User login information. -

      • getUserWithHttpInfo

        public ApiResponse<User> getUserWithHttpInfo​(UUID id)
                                      throws ApiException
        User Information Provides information about the user with the given ID.
        Parameters:
        id - The unique ID of the user. (required)
        Returns:
        ApiResponse<User>
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        200 User login information. -

      • 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 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
        List all environment variables 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
        List all environment variables 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. -

      • 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 branch,
                                                    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)
        branch - The name of a vcs branch. (optional)
        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 branch,
                                                                             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)
        branch - The name of a vcs branch. (optional)
        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. -

      • listWorkflowsByPipelineId

        public WorkflowListResponse listWorkflowsByPipelineId​(UUID pipelineId,
                                                      String pageToken)
                                               throws ApiException
        Get a pipeline's workflows Returns a paginated list of workflows by pipeline ID.
        Parameters:
        pipelineId - The unique ID of the pipeline. (required)
        pageToken - A token to retrieve the next page of results. (optional)
        Returns:
        WorkflowListResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        200 A paginated list of workflow objects. -

      • listWorkflowsByPipelineIdWithHttpInfo

        public ApiResponse<WorkflowListResponse> listWorkflowsByPipelineIdWithHttpInfo​(UUID pipelineId,
                                                                               String pageToken)
                                                                        throws ApiException
        Get a pipeline's workflows Returns a paginated list of workflows by pipeline ID.
        Parameters:
        pipelineId - The unique ID of the pipeline. (required)
        pageToken - A token to retrieve the next page of results. (optional)
        Returns:
        ApiResponse<WorkflowListResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        200 A paginated list of workflow objects. -

      • rerunWorkflow

        public MessageResponse rerunWorkflow​(UUID id,
                                     RerunWorkflowParameters rerunWorkflowParameters)
                              throws ApiException
        Rerun a workflow Reruns a workflow.
        Parameters:
        id - The unique ID of the workflow. (required)
        rerunWorkflowParameters - (optional)
        Returns:
        MessageResponse
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        202 A confirmation message. -

      • rerunWorkflowWithHttpInfo

        public ApiResponse<MessageResponse> rerunWorkflowWithHttpInfo​(UUID id,
                                                              RerunWorkflowParameters rerunWorkflowParameters)
                                                       throws ApiException
        Rerun a workflow Reruns a workflow.
        Parameters:
        id - The unique ID of the workflow. (required)
        rerunWorkflowParameters - (optional)
        Returns:
        ApiResponse<MessageResponse>
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        202 A confirmation message. -

      • triggerPipeline

        public PipelineLight triggerPipeline​(String projectSlug,
                                     String xAttributionLogin,
                                     String xAttributionActorId,
                                     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)
        xAttributionLogin - The login or user-readable identifier for the pipeline's triggerer. (optional)
        xAttributionActorId - The id the integration uses to identify the pipeline's triggerer. (optional)
        triggerPipelineParameters - (optional)
        Returns:
        PipelineLight
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        201 The created pipeline. -

      • triggerPipelineWithHttpInfo

        public ApiResponse<PipelineLight> triggerPipelineWithHttpInfo​(String projectSlug,
                                                              String xAttributionLogin,
                                                              String xAttributionActorId,
                                                              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)
        xAttributionLogin - The login or user-readable identifier for the pipeline's triggerer. (optional)
        xAttributionActorId - The id the integration uses to identify the pipeline's triggerer. (optional)
        triggerPipelineParameters - (optional)
        Returns:
        ApiResponse<PipelineLight>
        Throws:
        ApiException - if fails to make API call
        Http Response Details:
        Status Code Description Response Headers
        201 The created pipeline. -