Package com.launchdarkly.api.api

Class MetricsBetaApi

  • public class MetricsBetaApi
extends java.lang.Object

    • Constructor Detail

      • MetricsBetaApi

        public MetricsBetaApi()

      • MetricsBetaApi

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

      • createMetricGroupCall

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

      • createMetricGroup

        public MetricGroupRep createMetricGroup​(@Nonnull
                                        java.lang.String projectKey,
                                        @Nonnull
                                        MetricGroupPost metricGroupPost)
                                 throws ApiException
        Create metric group Create a new metric group in the specified project
        Parameters:
        projectKey - The project key (required)
        metricGroupPost - (required)
        Returns:
        MetricGroupRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createMetricGroupWithHttpInfo

        public ApiResponse<MetricGroupRep> createMetricGroupWithHttpInfo​(@Nonnull
                                                                 java.lang.String projectKey,
                                                                 @Nonnull
                                                                 MetricGroupPost metricGroupPost)
                                                          throws ApiException
        Create metric group Create a new metric group in the specified project
        Parameters:
        projectKey - The project key (required)
        metricGroupPost - (required)
        Returns:
        ApiResponse<MetricGroupRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createMetricGroupAsync

        public okhttp3.Call createMetricGroupAsync​(@Nonnull
                                           java.lang.String projectKey,
                                           @Nonnull
                                           MetricGroupPost metricGroupPost,
                                           ApiCallback<MetricGroupRep> _callback)
                                    throws ApiException
        Create metric group (asynchronously) Create a new metric group in the specified project
        Parameters:
        projectKey - The project key (required)
        metricGroupPost - (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

      • deleteMetricGroupCall

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

      • deleteMetricGroup

        public void deleteMetricGroup​(@Nonnull
                              java.lang.String projectKey,
                              @Nonnull
                              java.lang.String metricGroupKey)
                       throws ApiException
        Delete metric group Delete a metric group by key.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteMetricGroupWithHttpInfo

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

      • deleteMetricGroupAsync

        public okhttp3.Call deleteMetricGroupAsync​(@Nonnull
                                           java.lang.String projectKey,
                                           @Nonnull
                                           java.lang.String metricGroupKey,
                                           ApiCallback<java.lang.Void> _callback)
                                    throws ApiException
        Delete metric group (asynchronously) Delete a metric group by key.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric 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

      • getMetricGroupCall

        public okhttp3.Call getMetricGroupCall​(@Nonnull
                                       java.lang.String projectKey,
                                       @Nonnull
                                       java.lang.String metricGroupKey,
                                       @Nullable
                                       java.lang.String expand,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getMetricGroup
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group 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

      • getMetricGroup

        public MetricGroupRep getMetricGroup​(@Nonnull
                                     java.lang.String projectKey,
                                     @Nonnull
                                     java.lang.String metricGroupKey,
                                     @Nullable
                                     java.lang.String expand)
                              throws ApiException
        Get metric group Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" 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 either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        MetricGroupRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricGroupWithHttpInfo

        public ApiResponse<MetricGroupRep> getMetricGroupWithHttpInfo​(@Nonnull
                                                              java.lang.String projectKey,
                                                              @Nonnull
                                                              java.lang.String metricGroupKey,
                                                              @Nullable
                                                              java.lang.String expand)
                                                       throws ApiException
        Get metric group Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" 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 either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        Returns:
        ApiResponse<MetricGroupRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricGroupAsync

        public okhttp3.Call getMetricGroupAsync​(@Nonnull
                                        java.lang.String projectKey,
                                        @Nonnull
                                        java.lang.String metricGroupKey,
                                        @Nullable
                                        java.lang.String expand,
                                        ApiCallback<MetricGroupRep> _callback)
                                 throws ApiException
        Get metric group (asynchronously) Get information for a single metric group from the specific project. ### Expanding the metric group response LaunchDarkly supports two fields for expanding the \"Get metric group\" 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 either or both of the following fields: - `experiments` includes all experiments from the specific project that use the metric group - `experimentCount` includes the number of experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group 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

      • getMetricGroupsCall

        public okhttp3.Call getMetricGroupsCall​(@Nonnull
                                        java.lang.String projectKey,
                                        @Nullable
                                        java.lang.String filter,
                                        @Nullable
                                        java.lang.String sort,
                                        @Nullable
                                        java.lang.String expand,
                                        @Nullable
                                        java.lang.Long limit,
                                        @Nullable
                                        java.lang.Long offset,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getMetricGroups
        Parameters:
        projectKey - The project key (required)
        filter - Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
        expand - This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
        limit - The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMetricGroups

        public MetricGroupCollectionRep getMetricGroups​(@Nonnull
                                                java.lang.String projectKey,
                                                @Nullable
                                                java.lang.String filter,
                                                @Nullable
                                                java.lang.String sort,
                                                @Nullable
                                                java.lang.String expand,
                                                @Nullable
                                                java.lang.Long limit,
                                                @Nullable
                                                java.lang.Long offset)
                                         throws ApiException
        List metric groups Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
        Parameters:
        projectKey - The project key (required)
        filter - Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
        expand - This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
        limit - The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (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)
        Returns:
        MetricGroupCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricGroupsWithHttpInfo

        public ApiResponse<MetricGroupCollectionRep> getMetricGroupsWithHttpInfo​(@Nonnull
                                                                         java.lang.String projectKey,
                                                                         @Nullable
                                                                         java.lang.String filter,
                                                                         @Nullable
                                                                         java.lang.String sort,
                                                                         @Nullable
                                                                         java.lang.String expand,
                                                                         @Nullable
                                                                         java.lang.Long limit,
                                                                         @Nullable
                                                                         java.lang.Long offset)
                                                                  throws ApiException
        List metric groups Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
        Parameters:
        projectKey - The project key (required)
        filter - Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
        expand - This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
        limit - The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (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)
        Returns:
        ApiResponse<MetricGroupCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricGroupsAsync

        public okhttp3.Call getMetricGroupsAsync​(@Nonnull
                                         java.lang.String projectKey,
                                         @Nullable
                                         java.lang.String filter,
                                         @Nullable
                                         java.lang.String sort,
                                         @Nullable
                                         java.lang.String expand,
                                         @Nullable
                                         java.lang.Long limit,
                                         @Nullable
                                         java.lang.Long offset,
                                         ApiCallback<MetricGroupCollectionRep> _callback)
                                  throws ApiException
        List metric groups (asynchronously) Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
        Parameters:
        projectKey - The project key (required)
        filter - Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`. (optional)
        sort - A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. (optional)
        expand - This parameter is reserved for future use and is not currently supported on this endpoint. (optional)
        limit - The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (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)
        _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

      • patchMetricGroupCall

        public okhttp3.Call patchMetricGroupCall​(@Nonnull
                                         java.lang.String projectKey,
                                         @Nonnull
                                         java.lang.String metricGroupKey,
                                         @Nonnull
                                         java.util.List<PatchOperation> patchOperation,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for patchMetricGroup
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric 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

      • patchMetricGroup

        public MetricGroupRep patchMetricGroup​(@Nonnull
                                       java.lang.String projectKey,
                                       @Nonnull
                                       java.lang.String metricGroupKey,
                                       @Nonnull
                                       java.util.List<PatchOperation> patchOperation)
                                throws ApiException
        Patch metric group Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric group key (required)
        patchOperation - (required)
        Returns:
        MetricGroupRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchMetricGroupWithHttpInfo

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

      • patchMetricGroupAsync

        public okhttp3.Call patchMetricGroupAsync​(@Nonnull
                                          java.lang.String projectKey,
                                          @Nonnull
                                          java.lang.String metricGroupKey,
                                          @Nonnull
                                          java.util.List<PatchOperation> patchOperation,
                                          ApiCallback<MetricGroupRep> _callback)
                                   throws ApiException
        Patch metric group (asynchronously) Patch a metric group by key. Updating a metric group uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes.
        Parameters:
        projectKey - The project key (required)
        metricGroupKey - The metric 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