Package com.launchdarkly.api.api

Class ReleasePipelinesBetaApi

  • public class ReleasePipelinesBetaApi
extends java.lang.Object

    • Constructor Detail

      • ReleasePipelinesBetaApi

        public ReleasePipelinesBetaApi()

      • ReleasePipelinesBetaApi

        public ReleasePipelinesBetaApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • deleteReleasePipelineCall

        public okhttp3.Call deleteReleasePipelineCall​(java.lang.String projectKey,
                                              java.lang.String pipelineKey,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for deleteReleasePipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteReleasePipeline

        public void deleteReleasePipeline​(java.lang.String projectKey,
                                  java.lang.String pipelineKey)
                           throws ApiException
        Delete release pipeline Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`.
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteReleasePipelineWithHttpInfo

        public ApiResponse<java.lang.Void> deleteReleasePipelineWithHttpInfo​(java.lang.String projectKey,
                                                                     java.lang.String pipelineKey)
                                                              throws ApiException
        Delete release pipeline Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`.
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteReleasePipelineAsync

        public okhttp3.Call deleteReleasePipelineAsync​(java.lang.String projectKey,
                                               java.lang.String pipelineKey,
                                               ApiCallback<java.lang.Void> _callback)
                                        throws ApiException
        Delete release pipeline (asynchronously) Deletes a release pipeline. You cannot delete the default release pipeline. If you want to delete a release pipeline that is currently the default, create a second release pipeline and set it as the default. Then delete the first release pipeline. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`.
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getAllReleasePipelinesCall

        public okhttp3.Call getAllReleasePipelinesCall​(java.lang.String projectKey,
                                               java.lang.String filter,
                                               java.lang.Long limit,
                                               java.lang.Long offset,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getAllReleasePipelines
        Parameters:
        projectKey - The project key (required)
        filter - A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional)
        limit - The maximum number of items to return. Defaults to 20. (optional)
        offset - Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getAllReleasePipelines

        public ReleasePipelineCollection getAllReleasePipelines​(java.lang.String projectKey,
                                                        java.lang.String filter,
                                                        java.lang.Long limit,
                                                        java.lang.Long offset)
                                                 throws ApiException
        Get all release pipelines Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`.
        Parameters:
        projectKey - The project key (required)
        filter - A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional)
        limit - The maximum number of items to return. Defaults to 20. (optional)
        offset - Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        Returns:
        ReleasePipelineCollection
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllReleasePipelinesWithHttpInfo

        public ApiResponse<ReleasePipelineCollection> getAllReleasePipelinesWithHttpInfo​(java.lang.String projectKey,
                                                                                 java.lang.String filter,
                                                                                 java.lang.Long limit,
                                                                                 java.lang.Long offset)
                                                                          throws ApiException
        Get all release pipelines Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`.
        Parameters:
        projectKey - The project key (required)
        filter - A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional)
        limit - The maximum number of items to return. Defaults to 20. (optional)
        offset - Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        Returns:
        ApiResponse<ReleasePipelineCollection>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllReleasePipelinesAsync

        public okhttp3.Call getAllReleasePipelinesAsync​(java.lang.String projectKey,
                                                java.lang.String filter,
                                                java.lang.Long limit,
                                                java.lang.Long offset,
                                                ApiCallback<ReleasePipelineCollection> _callback)
                                         throws ApiException
        Get all release pipelines (asynchronously) Get all release pipelines for a project. ### Filtering release pipelines LaunchDarkly supports the following fields for filters: - `query` is a string that matches against the release pipeline `key`, `name`, and `description`. It is not case sensitive. For example: `?filter=query:examplePipeline`.
        Parameters:
        projectKey - The project key (required)
        filter - A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. (optional)
        limit - The maximum number of items to return. Defaults to 20. (optional)
        offset - Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getReleasePipelineByKeyCall

        public okhttp3.Call getReleasePipelineByKeyCall​(java.lang.String projectKey,
                                                java.lang.String pipelineKey,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getReleasePipelineByKey
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getReleasePipelineByKey

        public ReleasePipeline getReleasePipelineByKey​(java.lang.String projectKey,
                                               java.lang.String pipelineKey)
                                        throws ApiException
        Get release pipeline by key Get a release pipeline by key
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Returns:
        ReleasePipeline
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getReleasePipelineByKeyWithHttpInfo

        public ApiResponse<ReleasePipeline> getReleasePipelineByKeyWithHttpInfo​(java.lang.String projectKey,
                                                                        java.lang.String pipelineKey)
                                                                 throws ApiException
        Get release pipeline by key Get a release pipeline by key
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Returns:
        ApiResponse<ReleasePipeline>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getReleasePipelineByKeyAsync

        public okhttp3.Call getReleasePipelineByKeyAsync​(java.lang.String projectKey,
                                                 java.lang.String pipelineKey,
                                                 ApiCallback<ReleasePipeline> _callback)
                                          throws ApiException
        Get release pipeline by key (asynchronously) Get a release pipeline by key
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • patchReleasePipelineCall

        public okhttp3.Call patchReleasePipelineCall​(java.lang.String projectKey,
                                             java.lang.String pipelineKey,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for patchReleasePipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchReleasePipeline

        public ReleasePipeline patchReleasePipeline​(java.lang.String projectKey,
                                            java.lang.String pipelineKey)
                                     throws ApiException
        Update a release pipeline Updates a release pipeline. Updating a release pipeline uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Returns:
        ReleasePipeline
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchReleasePipelineWithHttpInfo

        public ApiResponse<ReleasePipeline> patchReleasePipelineWithHttpInfo​(java.lang.String projectKey,
                                                                     java.lang.String pipelineKey)
                                                              throws ApiException
        Update a release pipeline Updates a release pipeline. Updating a release pipeline uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        Returns:
        ApiResponse<ReleasePipeline>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchReleasePipelineAsync

        public okhttp3.Call patchReleasePipelineAsync​(java.lang.String projectKey,
                                              java.lang.String pipelineKey,
                                              ApiCallback<ReleasePipeline> _callback)
                                       throws ApiException
        Update a release pipeline (asynchronously) Updates a release pipeline. Updating a release pipeline uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postReleasePipelineCall

        public okhttp3.Call postReleasePipelineCall​(java.lang.String projectKey,
                                            CreateReleasePipelineInput createReleasePipelineInput,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for postReleasePipeline
        Parameters:
        projectKey - The project key (required)
        createReleasePipelineInput - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postReleasePipeline

        public ReleasePipeline postReleasePipeline​(java.lang.String projectKey,
                                           CreateReleasePipelineInput createReleasePipelineInput)
                                    throws ApiException
        Create a release pipeline Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.
        Parameters:
        projectKey - The project key (required)
        createReleasePipelineInput - (required)
        Returns:
        ReleasePipeline
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postReleasePipelineWithHttpInfo

        public ApiResponse<ReleasePipeline> postReleasePipelineWithHttpInfo​(java.lang.String projectKey,
                                                                    CreateReleasePipelineInput createReleasePipelineInput)
                                                             throws ApiException
        Create a release pipeline Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.
        Parameters:
        projectKey - The project key (required)
        createReleasePipelineInput - (required)
        Returns:
        ApiResponse<ReleasePipeline>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postReleasePipelineAsync

        public okhttp3.Call postReleasePipelineAsync​(java.lang.String projectKey,
                                             CreateReleasePipelineInput createReleasePipelineInput,
                                             ApiCallback<ReleasePipeline> _callback)
                                      throws ApiException
        Create a release pipeline (asynchronously) Creates a new release pipeline. The first release pipeline you create is automatically set as the default release pipeline for your project. To change the default release pipeline, use the [Update project](/tag/Projects#operation/patchProject) API to set the `defaultReleasePipelineKey`. You can create up to 20 release pipelines per project.
        Parameters:
        projectKey - The project key (required)
        createReleasePipelineInput - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object