Package com.launchdarkly.api.api

Class ProjectsApi

  • public class ProjectsApi
extends java.lang.Object

    • Constructor Detail

      • ProjectsApi

        public ProjectsApi()

      • ProjectsApi

        public ProjectsApi​(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)

      • deleteProjectCall

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

      • deleteProject

        public void deleteProject​(java.lang.String projectKey)
                   throws ApiException
        Delete project Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
        Parameters:
        projectKey - The project key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteProjectWithHttpInfo

        public ApiResponse<java.lang.Void> deleteProjectWithHttpInfo​(java.lang.String projectKey)
                                                      throws ApiException
        Delete project Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
        Parameters:
        projectKey - The project key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteProjectAsync

        public okhttp3.Call deleteProjectAsync​(java.lang.String projectKey,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException
        Delete project (asynchronously) Delete a project by key. Use this endpoint with caution. Deleting a project will delete all associated environments and feature flags. You cannot delete the last project in an account.
        Parameters:
        projectKey - The project 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

      • getProjectCall

        public okhttp3.Call getProjectCall​(java.lang.String projectKey,
                                   java.lang.String expand,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getProject
        Parameters:
        projectKey - The project key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getProject

        public Project getProject​(java.lang.String projectKey,
                          java.lang.String expand)
                   throws ApiException
        Get project Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response.
        Parameters:
        projectKey - The project key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        Project
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getProjectWithHttpInfo

        public ApiResponse<Project> getProjectWithHttpInfo​(java.lang.String projectKey,
                                                   java.lang.String expand)
                                            throws ApiException
        Get project Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response.
        Parameters:
        projectKey - The project key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<Project>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getProjectAsync

        public okhttp3.Call getProjectAsync​(java.lang.String projectKey,
                                    java.lang.String expand,
                                    ApiCallback<Project> _callback)
                             throws ApiException
        Get project (asynchronously) Get a single project by key. ### Expanding the project response LaunchDarkly supports one field for expanding the \"Get project\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with any of the following fields: * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for the project in the response.
        Parameters:
        projectKey - The project key. (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (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

      • getProjectsCall

        public okhttp3.Call getProjectsCall​(java.lang.Long limit,
                                    java.lang.Long offset,
                                    java.lang.String filter,
                                    java.lang.String expand,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for getProjects
        Parameters:
        limit - The number of projects to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getProjects

        public Projects getProjects​(java.lang.Long limit,
                            java.lang.Long offset,
                            java.lang.String filter,
                            java.lang.String expand)
                     throws ApiException
        List projects Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports two fields for filters: - `query` is a string that matches against the projects' names and keys. It is not case sensitive. - `tags` is a `+` separate list of project tags. It filters the list of projects that have all of the tags in the list. For example, the filter `query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. `Environments` includes a paginated list of the project environments. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response.
        Parameters:
        limit - The number of projects to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        Projects
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getProjectsWithHttpInfo

        public ApiResponse<Projects> getProjectsWithHttpInfo​(java.lang.Long limit,
                                                     java.lang.Long offset,
                                                     java.lang.String filter,
                                                     java.lang.String expand)
                                              throws ApiException
        List projects Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports two fields for filters: - `query` is a string that matches against the projects' names and keys. It is not case sensitive. - `tags` is a `+` separate list of project tags. It filters the list of projects that have all of the tags in the list. For example, the filter `query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. `Environments` includes a paginated list of the project environments. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response.
        Parameters:
        limit - The number of projects to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<Projects>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getProjectsAsync

        public okhttp3.Call getProjectsAsync​(java.lang.Long limit,
                                     java.lang.Long offset,
                                     java.lang.String filter,
                                     java.lang.String expand,
                                     ApiCallback<Projects> _callback)
                              throws ApiException
        List projects (asynchronously) Return a list of projects. By default, this returns the first 20 projects. Page through this list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the `_links` field that returns. If those links do not appear, the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page. ### Filtering projects LaunchDarkly supports two fields for filters: - `query` is a string that matches against the projects' names and keys. It is not case sensitive. - `tags` is a `+` separate list of project tags. It filters the list of projects that have all of the tags in the list. For example, the filter `query:abc,tags:tag-1+tag-2` matches projects with the string `abc` in their name or key and also are tagged with `tag-1` and `tag-2`. The filter is not case-sensitive. ### Sorting projects LaunchDarkly supports two fields for sorting: - `name` sorts by project name. - `createdOn` sorts by the creation date of the project. For example, `sort=name` sorts the response by project name in ascending order. ### Expanding the projects response LaunchDarkly supports one field for expanding the \"List projects\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the `environments` field. `Environments` includes a paginated list of the project environments. * `environments` includes a paginated list of the project environments. For example, `expand=environments` includes the `environments` field for each project in the response.
        Parameters:
        limit - The number of projects to return in the response. Defaults to 20. (optional)
        offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items. (optional)
        filter - A comma-separated list of filters. Each filter is constructed as `field:value`. (optional)
        expand - A comma-separated list of properties that can reveal additional information in the response. (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

      • patchProjectCall

        public okhttp3.Call patchProjectCall​(java.lang.String projectKey,
                                     java.util.List<PatchOperation> patchOperation,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for patchProject
        Parameters:
        projectKey - The project key (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchProject

        public ProjectRep patchProject​(java.lang.String projectKey,
                               java.util.List<PatchOperation> patchOperation)
                        throws ApiException
        Update project Update a project. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the project.
        Parameters:
        projectKey - The project key (required)
        patchOperation - (required)
        Returns:
        ProjectRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchProjectWithHttpInfo

        public ApiResponse<ProjectRep> patchProjectWithHttpInfo​(java.lang.String projectKey,
                                                        java.util.List<PatchOperation> patchOperation)
                                                 throws ApiException
        Update project Update a project. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the project.
        Parameters:
        projectKey - The project key (required)
        patchOperation - (required)
        Returns:
        ApiResponse<ProjectRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchProjectAsync

        public okhttp3.Call patchProjectAsync​(java.lang.String projectKey,
                                      java.util.List<PatchOperation> patchOperation,
                                      ApiCallback<ProjectRep> _callback)
                               throws ApiException
        Update project (asynchronously) Update a project. Requires a [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the project.
        Parameters:
        projectKey - The project key (required)
        patchOperation - (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

      • postProjectCall

        public okhttp3.Call postProjectCall​(ProjectPost projectPost,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for postProject
        Parameters:
        projectPost - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postProject

        public ProjectRep postProject​(ProjectPost projectPost)
                       throws ApiException
        Create project Create a new project with the given key and name. Project keys must be unique within an account.
        Parameters:
        projectPost - (required)
        Returns:
        ProjectRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postProjectWithHttpInfo

        public ApiResponse<ProjectRep> postProjectWithHttpInfo​(ProjectPost projectPost)
                                                throws ApiException
        Create project Create a new project with the given key and name. Project keys must be unique within an account.
        Parameters:
        projectPost - (required)
        Returns:
        ApiResponse<ProjectRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postProjectAsync

        public okhttp3.Call postProjectAsync​(ProjectPost projectPost,
                                     ApiCallback<ProjectRep> _callback)
                              throws ApiException
        Create project (asynchronously) Create a new project with the given key and name. Project keys must be unique within an account.
        Parameters:
        projectPost - (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