Package com.launchdarkly.api.api

Class ContextSettingsApi

  • public class ContextSettingsApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      int getHostIndex()  
      void putContextFlagSetting​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String contextKind, java.lang.String contextKey, java.lang.String featureFlagKey, ValuePut valuePut)
      Update flag settings for context Enable or disable a feature flag for a context based on its context kind and key.
      okhttp3.Call putContextFlagSettingAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String contextKind, java.lang.String contextKey, java.lang.String featureFlagKey, ValuePut valuePut, ApiCallback<java.lang.Void> _callback)
      Update flag settings for context (asynchronously) Enable or disable a feature flag for a context based on its context kind and key.
      okhttp3.Call putContextFlagSettingCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String contextKind, java.lang.String contextKey, java.lang.String featureFlagKey, ValuePut valuePut, ApiCallback _callback)
      Build call for putContextFlagSetting
      ApiResponse<java.lang.Void> putContextFlagSettingWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String contextKind, java.lang.String contextKey, java.lang.String featureFlagKey, ValuePut valuePut)
      Update flag settings for context Enable or disable a feature flag for a context based on its context kind and key.
      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

      • ContextSettingsApi

        public ContextSettingsApi()

      • ContextSettingsApi

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

      • putContextFlagSettingCall

        public okhttp3.Call putContextFlagSettingCall​(@Nonnull
                                              java.lang.String projectKey,
                                              @Nonnull
                                              java.lang.String environmentKey,
                                              @Nonnull
                                              java.lang.String contextKind,
                                              @Nonnull
                                              java.lang.String contextKey,
                                              @Nonnull
                                              java.lang.String featureFlagKey,
                                              @Nonnull
                                              ValuePut valuePut,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for putContextFlagSetting
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        contextKind - The context kind (required)
        contextKey - The context key (required)
        featureFlagKey - The feature flag key (required)
        valuePut - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • putContextFlagSetting

        public void putContextFlagSetting​(@Nonnull
                                  java.lang.String projectKey,
                                  @Nonnull
                                  java.lang.String environmentKey,
                                  @Nonnull
                                  java.lang.String contextKind,
                                  @Nonnull
                                  java.lang.String contextKey,
                                  @Nonnull
                                  java.lang.String featureFlagKey,
                                  @Nonnull
                                  ValuePut valuePut)
                           throws ApiException
        Update flag settings for context Enable or disable a feature flag for a context based on its context kind and key. In the request body, the `setting` should be the variation value to set for the context. It must match the flag's variation type. For example, for a boolean flag you can use `\"setting\": true` or `\"setting\": false` in the request body. For a string flag, you can use `\"setting\": \"existing_variation_value_to_use\"`. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context's key and kind before, it calculates the flag values based on the context kind and key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        contextKind - The context kind (required)
        contextKey - The context key (required)
        featureFlagKey - The feature flag key (required)
        valuePut - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • putContextFlagSettingWithHttpInfo

        public ApiResponse<java.lang.Void> putContextFlagSettingWithHttpInfo​(@Nonnull
                                                                     java.lang.String projectKey,
                                                                     @Nonnull
                                                                     java.lang.String environmentKey,
                                                                     @Nonnull
                                                                     java.lang.String contextKind,
                                                                     @Nonnull
                                                                     java.lang.String contextKey,
                                                                     @Nonnull
                                                                     java.lang.String featureFlagKey,
                                                                     @Nonnull
                                                                     ValuePut valuePut)
                                                              throws ApiException
        Update flag settings for context Enable or disable a feature flag for a context based on its context kind and key. In the request body, the `setting` should be the variation value to set for the context. It must match the flag's variation type. For example, for a boolean flag you can use `\"setting\": true` or `\"setting\": false` in the request body. For a string flag, you can use `\"setting\": \"existing_variation_value_to_use\"`. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context's key and kind before, it calculates the flag values based on the context kind and key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        contextKind - The context kind (required)
        contextKey - The context key (required)
        featureFlagKey - The feature flag key (required)
        valuePut - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • putContextFlagSettingAsync

        public okhttp3.Call putContextFlagSettingAsync​(@Nonnull
                                               java.lang.String projectKey,
                                               @Nonnull
                                               java.lang.String environmentKey,
                                               @Nonnull
                                               java.lang.String contextKind,
                                               @Nonnull
                                               java.lang.String contextKey,
                                               @Nonnull
                                               java.lang.String featureFlagKey,
                                               @Nonnull
                                               ValuePut valuePut,
                                               ApiCallback<java.lang.Void> _callback)
                                        throws ApiException
        Update flag settings for context (asynchronously) Enable or disable a feature flag for a context based on its context kind and key. In the request body, the `setting` should be the variation value to set for the context. It must match the flag's variation type. For example, for a boolean flag you can use `\"setting\": true` or `\"setting\": false` in the request body. For a string flag, you can use `\"setting\": \"existing_variation_value_to_use\"`. Omitting the `setting` attribute from the request body, or including a `setting` of `null`, erases the current setting for a context. If you previously patched the flag, and the patch included the context's data, LaunchDarkly continues to use that data. If LaunchDarkly has never encountered the combination of the context's key and kind before, it calculates the flag values based on the context kind and key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        contextKind - The context kind (required)
        contextKey - The context key (required)
        featureFlagKey - The feature flag key (required)
        valuePut - (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