Package com.launchdarkly.api.api

Class InsightsScoresBetaApi

  • public class InsightsScoresBetaApi
extends java.lang.Object

    • Constructor Detail

      • InsightsScoresBetaApi

        public InsightsScoresBetaApi()

      • InsightsScoresBetaApi

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

      • createInsightGroupCall

        public okhttp3.Call createInsightGroupCall​(@Nonnull
                                           PostInsightGroupParams postInsightGroupParams,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for createInsightGroup
        Parameters:
        postInsightGroupParams - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createInsightGroup

        public InsightGroup createInsightGroup​(@Nonnull
                                       PostInsightGroupParams postInsightGroupParams)
                                throws ApiException
        Create insight group Create insight group
        Parameters:
        postInsightGroupParams - (required)
        Returns:
        InsightGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createInsightGroupWithHttpInfo

        public ApiResponse<InsightGroup> createInsightGroupWithHttpInfo​(@Nonnull
                                                                PostInsightGroupParams postInsightGroupParams)
                                                         throws ApiException
        Create insight group Create insight group
        Parameters:
        postInsightGroupParams - (required)
        Returns:
        ApiResponse<InsightGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createInsightGroupAsync

        public okhttp3.Call createInsightGroupAsync​(@Nonnull
                                            PostInsightGroupParams postInsightGroupParams,
                                            ApiCallback<InsightGroup> _callback)
                                     throws ApiException
        Create insight group (asynchronously) Create insight group
        Parameters:
        postInsightGroupParams - (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

      • deleteInsightGroupCall

        public okhttp3.Call deleteInsightGroupCall​(@Nonnull
                                           java.lang.String insightGroupKey,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for deleteInsightGroup
        Parameters:
        insightGroupKey - The insight group key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteInsightGroup

        public void deleteInsightGroup​(@Nonnull
                               java.lang.String insightGroupKey)
                        throws ApiException
        Delete insight group Delete insight group
        Parameters:
        insightGroupKey - The insight group key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteInsightGroupWithHttpInfo

        public ApiResponse<java.lang.Void> deleteInsightGroupWithHttpInfo​(@Nonnull
                                                                  java.lang.String insightGroupKey)
                                                           throws ApiException
        Delete insight group Delete insight group
        Parameters:
        insightGroupKey - The insight group key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteInsightGroupAsync

        public okhttp3.Call deleteInsightGroupAsync​(@Nonnull
                                            java.lang.String insightGroupKey,
                                            ApiCallback<java.lang.Void> _callback)
                                     throws ApiException
        Delete insight group (asynchronously) Delete insight group
        Parameters:
        insightGroupKey - The insight group 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

      • getInsightGroupCall

        public okhttp3.Call getInsightGroupCall​(@Nonnull
                                        java.lang.String insightGroupKey,
                                        @Nullable
                                        java.lang.String expand,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getInsightGroup
        Parameters:
        insightGroupKey - The insight group key (required)
        expand - Options: `scores`, `environment` (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getInsightGroup

        public InsightGroup getInsightGroup​(@Nonnull
                                    java.lang.String insightGroupKey,
                                    @Nullable
                                    java.lang.String expand)
                             throws ApiException
        Get insight group Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        insightGroupKey - The insight group key (required)
        expand - Options: `scores`, `environment` (optional)
        Returns:
        InsightGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightGroupWithHttpInfo

        public ApiResponse<InsightGroup> getInsightGroupWithHttpInfo​(@Nonnull
                                                             java.lang.String insightGroupKey,
                                                             @Nullable
                                                             java.lang.String expand)
                                                      throws ApiException
        Get insight group Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        insightGroupKey - The insight group key (required)
        expand - Options: `scores`, `environment` (optional)
        Returns:
        ApiResponse<InsightGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightGroupAsync

        public okhttp3.Call getInsightGroupAsync​(@Nonnull
                                         java.lang.String insightGroupKey,
                                         @Nullable
                                         java.lang.String expand,
                                         ApiCallback<InsightGroup> _callback)
                                  throws ApiException
        Get insight group (asynchronously) Get insight group ### Expanding the insight group response LaunchDarkly supports expanding the insight group response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for this group * `environment` includes details on each environment associated with this group For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        insightGroupKey - The insight group key (required)
        expand - Options: `scores`, `environment` (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

      • getInsightGroupsCall

        public okhttp3.Call getInsightGroupsCall​(@Nullable
                                         java.lang.Long limit,
                                         @Nullable
                                         java.lang.Long offset,
                                         @Nullable
                                         java.lang.String sort,
                                         @Nullable
                                         java.lang.String query,
                                         @Nullable
                                         java.lang.String expand,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getInsightGroups
        Parameters:
        limit - The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. (optional)
        offset - Where to start in the list. 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)
        sort - Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name (optional)
        query - Filter list of insights groups by name. (optional)
        expand - Options: `scores`, `environment`, `metadata` (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getInsightGroups

        public InsightGroupCollection getInsightGroups​(@Nullable
                                               java.lang.Long limit,
                                               @Nullable
                                               java.lang.Long offset,
                                               @Nullable
                                               java.lang.String sort,
                                               @Nullable
                                               java.lang.String query,
                                               @Nullable
                                               java.lang.String expand)
                                        throws ApiException
        List insight groups List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        limit - The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. (optional)
        offset - Where to start in the list. 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)
        sort - Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name (optional)
        query - Filter list of insights groups by name. (optional)
        expand - Options: `scores`, `environment`, `metadata` (optional)
        Returns:
        InsightGroupCollection
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightGroupsWithHttpInfo

        public ApiResponse<InsightGroupCollection> getInsightGroupsWithHttpInfo​(@Nullable
                                                                        java.lang.Long limit,
                                                                        @Nullable
                                                                        java.lang.Long offset,
                                                                        @Nullable
                                                                        java.lang.String sort,
                                                                        @Nullable
                                                                        java.lang.String query,
                                                                        @Nullable
                                                                        java.lang.String expand)
                                                                 throws ApiException
        List insight groups List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        limit - The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. (optional)
        offset - Where to start in the list. 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)
        sort - Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name (optional)
        query - Filter list of insights groups by name. (optional)
        expand - Options: `scores`, `environment`, `metadata` (optional)
        Returns:
        ApiResponse<InsightGroupCollection>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightGroupsAsync

        public okhttp3.Call getInsightGroupsAsync​(@Nullable
                                          java.lang.Long limit,
                                          @Nullable
                                          java.lang.Long offset,
                                          @Nullable
                                          java.lang.String sort,
                                          @Nullable
                                          java.lang.String query,
                                          @Nullable
                                          java.lang.String expand,
                                          ApiCallback<InsightGroupCollection> _callback)
                                   throws ApiException
        List insight groups (asynchronously) List groups for which you are collecting insights ### Expanding the insight groups collection response LaunchDarkly supports expanding the insight groups collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `scores` includes details on all of the scores used in the engineering insights metrics views for each group * `environment` includes details on each environment associated with each group * `metadata` includes counts of the number of insight groups with particular indicators, such as \"excellent,\" \"good,\" \"fair,\" and so on. For example, use `?expand=scores` to include the `scores` field in the response. By default, this field is **not** included in the response.
        Parameters:
        limit - The number of insight groups to return. Default is 20. Must be between 1 and 20 inclusive. (optional)
        offset - Where to start in the list. 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)
        sort - Sort flag list by field. Prefix field with <code>-</code> to sort in descending order. Allowed fields: name (optional)
        query - Filter list of insights groups by name. (optional)
        expand - Options: `scores`, `environment`, `metadata` (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

      • getInsightsScoresCall

        public okhttp3.Call getInsightsScoresCall​(@Nonnull
                                          java.lang.String projectKey,
                                          @Nonnull
                                          java.lang.String environmentKey,
                                          @Nullable
                                          java.lang.String applicationKey,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for getInsightsScores
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getInsightsScores

        public InsightScores getInsightsScores​(@Nonnull
                                       java.lang.String projectKey,
                                       @Nonnull
                                       java.lang.String environmentKey,
                                       @Nullable
                                       java.lang.String applicationKey)
                                throws ApiException
        Get insight scores Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        Returns:
        InsightScores
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightsScoresWithHttpInfo

        public ApiResponse<InsightScores> getInsightsScoresWithHttpInfo​(@Nonnull
                                                                java.lang.String projectKey,
                                                                @Nonnull
                                                                java.lang.String environmentKey,
                                                                @Nullable
                                                                java.lang.String applicationKey)
                                                         throws ApiException
        Get insight scores Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        Returns:
        ApiResponse<InsightScores>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getInsightsScoresAsync

        public okhttp3.Call getInsightsScoresAsync​(@Nonnull
                                           java.lang.String projectKey,
                                           @Nonnull
                                           java.lang.String environmentKey,
                                           @Nullable
                                           java.lang.String applicationKey,
                                           ApiCallback<InsightScores> _callback)
                                    throws ApiException
        Get insight scores (asynchronously) Return insights scores, based on the given parameters. This data is also used in engineering insights metrics views.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (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

      • patchInsightGroupCall

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

      • patchInsightGroup

        public InsightGroup patchInsightGroup​(@Nonnull
                                      java.lang.String insightGroupKey,
                                      @Nonnull
                                      java.util.List<PatchOperation> patchOperation)
                               throws ApiException
        Patch insight group Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).
        Parameters:
        insightGroupKey - The insight group key (required)
        patchOperation - (required)
        Returns:
        InsightGroup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchInsightGroupWithHttpInfo

        public ApiResponse<InsightGroup> patchInsightGroupWithHttpInfo​(@Nonnull
                                                               java.lang.String insightGroupKey,
                                                               @Nonnull
                                                               java.util.List<PatchOperation> patchOperation)
                                                        throws ApiException
        Patch insight group Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).
        Parameters:
        insightGroupKey - The insight group key (required)
        patchOperation - (required)
        Returns:
        ApiResponse<InsightGroup>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchInsightGroupAsync

        public okhttp3.Call patchInsightGroupAsync​(@Nonnull
                                           java.lang.String insightGroupKey,
                                           @Nonnull
                                           java.util.List<PatchOperation> patchOperation,
                                           ApiCallback<InsightGroup> _callback)
                                    throws ApiException
        Patch insight group (asynchronously) Update an insight group. Updating an insight group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).
        Parameters:
        insightGroupKey - The insight group 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