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​(@Nonnull
                                              java.lang.String projectKey,
                                              @Nonnull
                                              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​(@Nonnull
                                  java.lang.String projectKey,
                                  @Nonnull
                                  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](https://launchdarkly.com/docs/api/projects/patch-project) 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​(@Nonnull
                                                                     java.lang.String projectKey,
                                                                     @Nonnull
                                                                     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](https://launchdarkly.com/docs/api/projects/patch-project) 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​(@Nonnull
                                               java.lang.String projectKey,
                                               @Nonnull
                                               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](https://launchdarkly.com/docs/api/projects/patch-project) 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​(@Nonnull
                                               java.lang.String projectKey,
                                               @Nullable
                                               java.lang.String filter,
                                               @Nullable
                                               java.lang.Long limit,
                                               @Nullable
                                               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​(@Nonnull
                                                        java.lang.String projectKey,
                                                        @Nullable
                                                        java.lang.String filter,
                                                        @Nullable
                                                        java.lang.Long limit,
                                                        @Nullable
                                                        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`. - `env` is a string that matches an environment key. For example: `?filter=env:production`.
        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​(@Nonnull
                                                                                 java.lang.String projectKey,
                                                                                 @Nullable
                                                                                 java.lang.String filter,
                                                                                 @Nullable
                                                                                 java.lang.Long limit,
                                                                                 @Nullable
                                                                                 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`. - `env` is a string that matches an environment key. For example: `?filter=env:production`.
        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​(@Nonnull
                                                java.lang.String projectKey,
                                                @Nullable
                                                java.lang.String filter,
                                                @Nullable
                                                java.lang.Long limit,
                                                @Nullable
                                                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`. - `env` is a string that matches an environment key. For example: `?filter=env:production`.
        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

      • getAllReleaseProgressionsForReleasePipelineCall

        public okhttp3.Call getAllReleaseProgressionsForReleasePipelineCall​(@Nonnull
                                                                    java.lang.String projectKey,
                                                                    @Nonnull
                                                                    java.lang.String pipelineKey,
                                                                    @Nullable
                                                                    java.lang.String filter,
                                                                    @Nullable
                                                                    java.lang.Long limit,
                                                                    @Nullable
                                                                    java.lang.Long offset,
                                                                    ApiCallback _callback)
                                                             throws ApiException
        Build call for getAllReleaseProgressionsForReleasePipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The pipeline key (required)
        filter - Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. (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

      • getAllReleaseProgressionsForReleasePipeline

        public ReleaseProgressionCollection getAllReleaseProgressionsForReleasePipeline​(@Nonnull
                                                                                java.lang.String projectKey,
                                                                                @Nonnull
                                                                                java.lang.String pipelineKey,
                                                                                @Nullable
                                                                                java.lang.String filter,
                                                                                @Nullable
                                                                                java.lang.Long limit,
                                                                                @Nullable
                                                                                java.lang.Long offset)
                                                                         throws ApiException
        Get release progressions for release pipeline Get details on the progression of all releases, across all flags, for a release pipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The pipeline key (required)
        filter - Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. (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:
        ReleaseProgressionCollection
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllReleaseProgressionsForReleasePipelineWithHttpInfo

        public ApiResponse<ReleaseProgressionCollection> getAllReleaseProgressionsForReleasePipelineWithHttpInfo​(@Nonnull
                                                                                                         java.lang.String projectKey,
                                                                                                         @Nonnull
                                                                                                         java.lang.String pipelineKey,
                                                                                                         @Nullable
                                                                                                         java.lang.String filter,
                                                                                                         @Nullable
                                                                                                         java.lang.Long limit,
                                                                                                         @Nullable
                                                                                                         java.lang.Long offset)
                                                                                                  throws ApiException
        Get release progressions for release pipeline Get details on the progression of all releases, across all flags, for a release pipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The pipeline key (required)
        filter - Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. (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<ReleaseProgressionCollection>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllReleaseProgressionsForReleasePipelineAsync

        public okhttp3.Call getAllReleaseProgressionsForReleasePipelineAsync​(@Nonnull
                                                                     java.lang.String projectKey,
                                                                     @Nonnull
                                                                     java.lang.String pipelineKey,
                                                                     @Nullable
                                                                     java.lang.String filter,
                                                                     @Nullable
                                                                     java.lang.Long limit,
                                                                     @Nullable
                                                                     java.lang.Long offset,
                                                                     ApiCallback<ReleaseProgressionCollection> _callback)
                                                              throws ApiException
        Get release progressions for release pipeline (asynchronously) Get details on the progression of all releases, across all flags, for a release pipeline
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The pipeline key (required)
        filter - Accepts filter by `status` and `activePhaseId`. `status` can take a value of `completed` or `active`. `activePhaseId` takes a UUID and will filter results down to releases active on the specified phase. Providing `status equals completed` along with an `activePhaseId` filter will return an error as they are disjoint sets of data. The combination of `status equals active` and `activePhaseId` will return the same results as `activePhaseId` alone. (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​(@Nonnull
                                                java.lang.String projectKey,
                                                @Nonnull
                                                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​(@Nonnull
                                               java.lang.String projectKey,
                                               @Nonnull
                                               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​(@Nonnull
                                                                        java.lang.String projectKey,
                                                                        @Nonnull
                                                                        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​(@Nonnull
                                                 java.lang.String projectKey,
                                                 @Nonnull
                                                 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

      • postReleasePipelineCall

        public okhttp3.Call postReleasePipelineCall​(@Nonnull
                                            java.lang.String projectKey,
                                            @Nonnull
                                            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​(@Nonnull
                                           java.lang.String projectKey,
                                           @Nonnull
                                           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](https://launchdarkly.com/docs/api/projects/patch-project) 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​(@Nonnull
                                                                    java.lang.String projectKey,
                                                                    @Nonnull
                                                                    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](https://launchdarkly.com/docs/api/projects/patch-project) 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​(@Nonnull
                                             java.lang.String projectKey,
                                             @Nonnull
                                             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](https://launchdarkly.com/docs/api/projects/patch-project) 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

      • putReleasePipelineCall

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

      • putReleasePipeline

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

      • putReleasePipelineWithHttpInfo

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

      • putReleasePipelineAsync

        public okhttp3.Call putReleasePipelineAsync​(@Nonnull
                                            java.lang.String projectKey,
                                            @Nonnull
                                            java.lang.String pipelineKey,
                                            @Nonnull
                                            UpdateReleasePipelineInput updateReleasePipelineInput,
                                            ApiCallback<ReleasePipeline> _callback)
                                     throws ApiException
        Update a release pipeline (asynchronously) Updates a release pipeline.
        Parameters:
        projectKey - The project key (required)
        pipelineKey - The release pipeline key (required)
        updateReleasePipelineInput - (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