Package com.launchdarkly.api.api

Class MetricsApi

  • public class MetricsApi
extends java.lang.Object

    • Constructor Detail

      • MetricsApi

        public MetricsApi()

      • MetricsApi

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

      • deleteMetricCall

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

      • deleteMetric

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

      • deleteMetricWithHttpInfo

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

      • deleteMetricAsync

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

      • getMetricCall

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

      • getMetric

        public MetricRep getMetric​(java.lang.String projectKey,
                           java.lang.String metricKey,
                           java.lang.String expand,
                           java.lang.String versionId)
                    throws ApiException
        Get metric Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" 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: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response.
        Parameters:
        projectKey - The project key (required)
        metricKey - The metric key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        versionId - The specific version ID of the metric (optional)
        Returns:
        MetricRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricWithHttpInfo

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

      • getMetricAsync

        public okhttp3.Call getMetricAsync​(java.lang.String projectKey,
                                   java.lang.String metricKey,
                                   java.lang.String expand,
                                   java.lang.String versionId,
                                   ApiCallback<MetricRep> _callback)
                            throws ApiException
        Get metric (asynchronously) Get information for a single metric from the specific project. ### Expanding the metric response LaunchDarkly supports four fields for expanding the \"Get metric\" 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: - `experiments` includes all experiments from the specific project that use the metric - `experimentCount` includes the number of experiments from the specific project that use the metric - `metricGroups` includes all metric groups from the specific project that use the metric - `metricGroupCount` includes the number of metric groups from the specific project that use the metric For example, `expand=experiments` includes the `experiments` field in the response.
        Parameters:
        projectKey - The project key (required)
        metricKey - The metric key (required)
        expand - A comma-separated list of properties that can reveal additional information in the response. (optional)
        versionId - The specific version ID of the metric (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

      • getMetricsCall

        public okhttp3.Call getMetricsCall​(java.lang.String projectKey,
                                   java.lang.String expand,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for getMetrics
        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

      • getMetrics

        public MetricCollectionRep getMetrics​(java.lang.String projectKey,
                                      java.lang.String expand)
                               throws ApiException
        List metrics Get a list of all metrics for the specified project. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric 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:
        MetricCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricsWithHttpInfo

        public ApiResponse<MetricCollectionRep> getMetricsWithHttpInfo​(java.lang.String projectKey,
                                                               java.lang.String expand)
                                                        throws ApiException
        List metrics Get a list of all metrics for the specified project. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric 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<MetricCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMetricsAsync

        public okhttp3.Call getMetricsAsync​(java.lang.String projectKey,
                                    java.lang.String expand,
                                    ApiCallback<MetricCollectionRep> _callback)
                             throws ApiException
        List metrics (asynchronously) Get a list of all metrics for the specified project. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric 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

      • patchMetricCall

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

      • patchMetric

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

      • patchMetricWithHttpInfo

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

      • patchMetricAsync

        public okhttp3.Call patchMetricAsync​(java.lang.String projectKey,
                                     java.lang.String metricKey,
                                     java.util.List<PatchOperation> patchOperation,
                                     ApiCallback<MetricRep> _callback)
                              throws ApiException
        Update metric (asynchronously) Patch a metric by key. Updating a metric uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](/#section/Overview/Updates).
        Parameters:
        projectKey - The project key (required)
        metricKey - The metric 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

      • postMetricCall

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

      • postMetric

        public MetricRep postMetric​(java.lang.String projectKey,
                            MetricPost metricPost)
                     throws ApiException
        Create metric Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property.
        Parameters:
        projectKey - The project key (required)
        metricPost - (required)
        Returns:
        MetricRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMetricWithHttpInfo

        public ApiResponse<MetricRep> postMetricWithHttpInfo​(java.lang.String projectKey,
                                                     MetricPost metricPost)
                                              throws ApiException
        Create metric Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property.
        Parameters:
        projectKey - The project key (required)
        metricPost - (required)
        Returns:
        ApiResponse<MetricRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postMetricAsync

        public okhttp3.Call postMetricAsync​(java.lang.String projectKey,
                                    MetricPost metricPost,
                                    ApiCallback<MetricRep> _callback)
                             throws ApiException
        Create metric (asynchronously) Create a new metric in the specified project. The expected `POST` body differs depending on the specified `kind` property.
        Parameters:
        projectKey - The project key (required)
        metricPost - (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