Package com.launchdarkly.api.api

Class InsightsFlagEventsBetaApi

  • public class InsightsFlagEventsBetaApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      FlagEventCollectionRep getFlagEvents​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String query, java.lang.String impactSize, java.lang.Boolean hasExperiments, java.lang.String global, java.lang.String expand, java.lang.Long limit, java.lang.Long from, java.lang.Long to, java.lang.String after, java.lang.String before)
      List flag events Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields.
      okhttp3.Call getFlagEventsAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String query, java.lang.String impactSize, java.lang.Boolean hasExperiments, java.lang.String global, java.lang.String expand, java.lang.Long limit, java.lang.Long from, java.lang.Long to, java.lang.String after, java.lang.String before, ApiCallback<FlagEventCollectionRep> _callback)
      List flag events (asynchronously) Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields.
      okhttp3.Call getFlagEventsCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String query, java.lang.String impactSize, java.lang.Boolean hasExperiments, java.lang.String global, java.lang.String expand, java.lang.Long limit, java.lang.Long from, java.lang.Long to, java.lang.String after, java.lang.String before, ApiCallback _callback)
      Build call for getFlagEvents
      ApiResponse<FlagEventCollectionRep> getFlagEventsWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String applicationKey, java.lang.String query, java.lang.String impactSize, java.lang.Boolean hasExperiments, java.lang.String global, java.lang.String expand, java.lang.Long limit, java.lang.Long from, java.lang.Long to, java.lang.String after, java.lang.String before)
      List flag events Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields.
      int getHostIndex()  
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • InsightsFlagEventsBetaApi

        public InsightsFlagEventsBetaApi()

      • InsightsFlagEventsBetaApi

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

      • getFlagEventsCall

        public okhttp3.Call getFlagEventsCall​(@Nonnull
                                      java.lang.String projectKey,
                                      @Nonnull
                                      java.lang.String environmentKey,
                                      @Nullable
                                      java.lang.String applicationKey,
                                      @Nullable
                                      java.lang.String query,
                                      @Nullable
                                      java.lang.String impactSize,
                                      @Nullable
                                      java.lang.Boolean hasExperiments,
                                      @Nullable
                                      java.lang.String global,
                                      @Nullable
                                      java.lang.String expand,
                                      @Nullable
                                      java.lang.Long limit,
                                      @Nullable
                                      java.lang.Long from,
                                      @Nullable
                                      java.lang.Long to,
                                      @Nullable
                                      java.lang.String after,
                                      @Nullable
                                      java.lang.String before,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getFlagEvents
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        query - Filter events by flag key (optional)
        impactSize - Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` (optional)
        hasExperiments - Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
        global - Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
        expand - Expand properties in response. Options: `experiments` (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
        to - Unix timestamp in milliseconds. Default value is now. (optional)
        after - Identifier used for pagination (optional)
        before - Identifier used for pagination (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFlagEvents

        public FlagEventCollectionRep getFlagEvents​(@Nonnull
                                            java.lang.String projectKey,
                                            @Nonnull
                                            java.lang.String environmentKey,
                                            @Nullable
                                            java.lang.String applicationKey,
                                            @Nullable
                                            java.lang.String query,
                                            @Nullable
                                            java.lang.String impactSize,
                                            @Nullable
                                            java.lang.Boolean hasExperiments,
                                            @Nullable
                                            java.lang.String global,
                                            @Nullable
                                            java.lang.String expand,
                                            @Nullable
                                            java.lang.Long limit,
                                            @Nullable
                                            java.lang.Long from,
                                            @Nullable
                                            java.lang.Long to,
                                            @Nullable
                                            java.lang.String after,
                                            @Nullable
                                            java.lang.String before)
                                     throws ApiException
        List flag events Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        query - Filter events by flag key (optional)
        impactSize - Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` (optional)
        hasExperiments - Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
        global - Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
        expand - Expand properties in response. Options: `experiments` (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
        to - Unix timestamp in milliseconds. Default value is now. (optional)
        after - Identifier used for pagination (optional)
        before - Identifier used for pagination (optional)
        Returns:
        FlagEventCollectionRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFlagEventsWithHttpInfo

        public ApiResponse<FlagEventCollectionRep> getFlagEventsWithHttpInfo​(@Nonnull
                                                                     java.lang.String projectKey,
                                                                     @Nonnull
                                                                     java.lang.String environmentKey,
                                                                     @Nullable
                                                                     java.lang.String applicationKey,
                                                                     @Nullable
                                                                     java.lang.String query,
                                                                     @Nullable
                                                                     java.lang.String impactSize,
                                                                     @Nullable
                                                                     java.lang.Boolean hasExperiments,
                                                                     @Nullable
                                                                     java.lang.String global,
                                                                     @Nullable
                                                                     java.lang.String expand,
                                                                     @Nullable
                                                                     java.lang.Long limit,
                                                                     @Nullable
                                                                     java.lang.Long from,
                                                                     @Nullable
                                                                     java.lang.Long to,
                                                                     @Nullable
                                                                     java.lang.String after,
                                                                     @Nullable
                                                                     java.lang.String before)
                                                              throws ApiException
        List flag events Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        query - Filter events by flag key (optional)
        impactSize - Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` (optional)
        hasExperiments - Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
        global - Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
        expand - Expand properties in response. Options: `experiments` (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
        to - Unix timestamp in milliseconds. Default value is now. (optional)
        after - Identifier used for pagination (optional)
        before - Identifier used for pagination (optional)
        Returns:
        ApiResponse<FlagEventCollectionRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFlagEventsAsync

        public okhttp3.Call getFlagEventsAsync​(@Nonnull
                                       java.lang.String projectKey,
                                       @Nonnull
                                       java.lang.String environmentKey,
                                       @Nullable
                                       java.lang.String applicationKey,
                                       @Nullable
                                       java.lang.String query,
                                       @Nullable
                                       java.lang.String impactSize,
                                       @Nullable
                                       java.lang.Boolean hasExperiments,
                                       @Nullable
                                       java.lang.String global,
                                       @Nullable
                                       java.lang.String expand,
                                       @Nullable
                                       java.lang.Long limit,
                                       @Nullable
                                       java.lang.Long from,
                                       @Nullable
                                       java.lang.Long to,
                                       @Nullable
                                       java.lang.String after,
                                       @Nullable
                                       java.lang.String before,
                                       ApiCallback<FlagEventCollectionRep> _callback)
                                throws ApiException
        List flag events (asynchronously) Get a list of flag events ### Expanding the flag event collection response LaunchDarkly supports expanding the flag event collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `experiments` includes details on all of the experiments run on each flag For example, use `?expand=experiments` to include the `experiments` field in the response. By default, this field is **not** included in the response.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        applicationKey - Comma separated list of application keys (optional)
        query - Filter events by flag key (optional)
        impactSize - Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` (optional)
        hasExperiments - Filter events to those associated with an experiment (`true`) or without an experiment (`false`) (optional)
        global - Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` (optional)
        expand - Expand properties in response. Options: `experiments` (optional)
        limit - The number of deployments to return. Default is 20. Maximum allowed is 100. (optional)
        from - Unix timestamp in milliseconds. Default value is 7 days ago. (optional)
        to - Unix timestamp in milliseconds. Default value is now. (optional)
        after - Identifier used for pagination (optional)
        before - Identifier used for pagination (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