Package com.launchdarkly.api.api

Class ScheduledChangesApi

  • public class ScheduledChangesApi
extends java.lang.Object

    • Constructor Detail

      • ScheduledChangesApi

        public ScheduledChangesApi()

      • ScheduledChangesApi

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

      • deleteFlagConfigScheduledChangesCall

        public okhttp3.Call deleteFlagConfigScheduledChangesCall​(java.lang.String projectKey,
                                                         java.lang.String featureFlagKey,
                                                         java.lang.String environmentKey,
                                                         java.lang.String id,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for deleteFlagConfigScheduledChanges
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteFlagConfigScheduledChanges

        public void deleteFlagConfigScheduledChanges​(java.lang.String projectKey,
                                             java.lang.String featureFlagKey,
                                             java.lang.String environmentKey,
                                             java.lang.String id)
                                      throws ApiException
        Delete scheduled changes workflow Delete a scheduled changes workflow.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteFlagConfigScheduledChangesWithHttpInfo

        public ApiResponse<java.lang.Void> deleteFlagConfigScheduledChangesWithHttpInfo​(java.lang.String projectKey,
                                                                                java.lang.String featureFlagKey,
                                                                                java.lang.String environmentKey,
                                                                                java.lang.String id)
                                                                         throws ApiException
        Delete scheduled changes workflow Delete a scheduled changes workflow.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteFlagConfigScheduledChangesAsync

        public okhttp3.Call deleteFlagConfigScheduledChangesAsync​(java.lang.String projectKey,
                                                          java.lang.String featureFlagKey,
                                                          java.lang.String environmentKey,
                                                          java.lang.String id,
                                                          ApiCallback<java.lang.Void> _callback)
                                                   throws ApiException
        Delete scheduled changes workflow (asynchronously) Delete a scheduled changes workflow.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (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

      • getFeatureFlagScheduledChangeCall

        public okhttp3.Call getFeatureFlagScheduledChangeCall​(java.lang.String projectKey,
                                                      java.lang.String featureFlagKey,
                                                      java.lang.String environmentKey,
                                                      java.lang.String id,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for getFeatureFlagScheduledChange
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFeatureFlagScheduledChange

        public FeatureFlagScheduledChange getFeatureFlagScheduledChange​(java.lang.String projectKey,
                                                                java.lang.String featureFlagKey,
                                                                java.lang.String environmentKey,
                                                                java.lang.String id)
                                                         throws ApiException
        Get a scheduled change Get a scheduled change that will be applied to the feature flag by ID.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        Returns:
        FeatureFlagScheduledChange
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureFlagScheduledChangeWithHttpInfo

        public ApiResponse<FeatureFlagScheduledChange> getFeatureFlagScheduledChangeWithHttpInfo​(java.lang.String projectKey,
                                                                                         java.lang.String featureFlagKey,
                                                                                         java.lang.String environmentKey,
                                                                                         java.lang.String id)
                                                                                  throws ApiException
        Get a scheduled change Get a scheduled change that will be applied to the feature flag by ID.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (required)
        Returns:
        ApiResponse<FeatureFlagScheduledChange>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureFlagScheduledChangeAsync

        public okhttp3.Call getFeatureFlagScheduledChangeAsync​(java.lang.String projectKey,
                                                       java.lang.String featureFlagKey,
                                                       java.lang.String environmentKey,
                                                       java.lang.String id,
                                                       ApiCallback<FeatureFlagScheduledChange> _callback)
                                                throws ApiException
        Get a scheduled change (asynchronously) Get a scheduled change that will be applied to the feature flag by ID.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change id (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

      • getFlagConfigScheduledChangesCall

        public okhttp3.Call getFlagConfigScheduledChangesCall​(java.lang.String projectKey,
                                                      java.lang.String featureFlagKey,
                                                      java.lang.String environmentKey,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for getFlagConfigScheduledChanges
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFlagConfigScheduledChanges

        public FeatureFlagScheduledChanges getFlagConfigScheduledChanges​(java.lang.String projectKey,
                                                                 java.lang.String featureFlagKey,
                                                                 java.lang.String environmentKey)
                                                          throws ApiException
        List scheduled changes Get a list of scheduled changes that will be applied to the feature flag.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        Returns:
        FeatureFlagScheduledChanges
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFlagConfigScheduledChangesWithHttpInfo

        public ApiResponse<FeatureFlagScheduledChanges> getFlagConfigScheduledChangesWithHttpInfo​(java.lang.String projectKey,
                                                                                          java.lang.String featureFlagKey,
                                                                                          java.lang.String environmentKey)
                                                                                   throws ApiException
        List scheduled changes Get a list of scheduled changes that will be applied to the feature flag.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        Returns:
        ApiResponse<FeatureFlagScheduledChanges>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFlagConfigScheduledChangesAsync

        public okhttp3.Call getFlagConfigScheduledChangesAsync​(java.lang.String projectKey,
                                                       java.lang.String featureFlagKey,
                                                       java.lang.String environmentKey,
                                                       ApiCallback<FeatureFlagScheduledChanges> _callback)
                                                throws ApiException
        List scheduled changes (asynchronously) Get a list of scheduled changes that will be applied to the feature flag.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment 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

      • patchFlagConfigScheduledChangeCall

        public okhttp3.Call patchFlagConfigScheduledChangeCall​(java.lang.String projectKey,
                                                       java.lang.String featureFlagKey,
                                                       java.lang.String environmentKey,
                                                       java.lang.String id,
                                                       FlagScheduledChangesInput flagScheduledChangesInput,
                                                       java.lang.Boolean ignoreConflicts,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for patchFlagConfigScheduledChange
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change ID (required)
        flagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • patchFlagConfigScheduledChange

        public FeatureFlagScheduledChange patchFlagConfigScheduledChange​(java.lang.String projectKey,
                                                                 java.lang.String featureFlagKey,
                                                                 java.lang.String environmentKey,
                                                                 java.lang.String id,
                                                                 FlagScheduledChangesInput flagScheduledChangesInput,
                                                                 java.lang.Boolean ignoreConflicts)
                                                          throws ApiException
        Update scheduled changes workflow Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes. <details> <summary>Click to expand instructions for <strong>updating scheduled changes</strong></summary> #### deleteScheduledChange Removes the scheduled change. Here's an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here's an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here's an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ``` </details>
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change ID (required)
        flagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes (optional)
        Returns:
        FeatureFlagScheduledChange
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchFlagConfigScheduledChangeWithHttpInfo

        public ApiResponse<FeatureFlagScheduledChange> patchFlagConfigScheduledChangeWithHttpInfo​(java.lang.String projectKey,
                                                                                          java.lang.String featureFlagKey,
                                                                                          java.lang.String environmentKey,
                                                                                          java.lang.String id,
                                                                                          FlagScheduledChangesInput flagScheduledChangesInput,
                                                                                          java.lang.Boolean ignoreConflicts)
                                                                                   throws ApiException
        Update scheduled changes workflow Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes. <details> <summary>Click to expand instructions for <strong>updating scheduled changes</strong></summary> #### deleteScheduledChange Removes the scheduled change. Here's an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here's an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here's an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ``` </details>
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change ID (required)
        flagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes (optional)
        Returns:
        ApiResponse<FeatureFlagScheduledChange>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • patchFlagConfigScheduledChangeAsync

        public okhttp3.Call patchFlagConfigScheduledChangeAsync​(java.lang.String projectKey,
                                                        java.lang.String featureFlagKey,
                                                        java.lang.String environmentKey,
                                                        java.lang.String id,
                                                        FlagScheduledChangesInput flagScheduledChangesInput,
                                                        java.lang.Boolean ignoreConflicts,
                                                        ApiCallback<FeatureFlagScheduledChange> _callback)
                                                 throws ApiException
        Update scheduled changes workflow (asynchronously) Update a scheduled change, overriding existing instructions with the new ones. Updating a scheduled change uses the semantic patch format. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](/reference#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating scheduled changes. <details> <summary>Click to expand instructions for <strong>updating scheduled changes</strong></summary> #### deleteScheduledChange Removes the scheduled change. Here's an example: ```json { \"instructions\": [{ \"kind\": \"deleteScheduledChange\" }] } ``` #### replaceScheduledChangesInstructions Removes the existing scheduled changes and replaces them with the new instructions. ##### Parameters - `value`: An array of the new actions to perform when the execution date for these scheduled changes arrives. Supported scheduled actions are `turnFlagOn` and `turnFlagOff`. Here's an example that replaces the scheduled changes with new instructions to turn flag targeting off: ```json { \"instructions\": [ { \"kind\": \"replaceScheduledChangesInstructions\", \"value\": [ {\"kind\": \"turnFlagOff\"} ] } ] } ``` #### updateScheduledChangesExecutionDate Updates the execution date for the scheduled changes. ##### Parameters - `value`: the new execution date, in Unix milliseconds. Here's an example: ```json { \"instructions\": [ { \"kind\": \"updateScheduledChangesExecutionDate\", \"value\": 1754092860000 } ] } ``` </details>
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        id - The scheduled change ID (required)
        flagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these new instructions conflict with existing scheduled changes (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

      • postFlagConfigScheduledChangesCall

        public okhttp3.Call postFlagConfigScheduledChangesCall​(java.lang.String projectKey,
                                                       java.lang.String featureFlagKey,
                                                       java.lang.String environmentKey,
                                                       PostFlagScheduledChangesInput postFlagScheduledChangesInput,
                                                       java.lang.Boolean ignoreConflicts,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for postFlagConfigScheduledChanges
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        postFlagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • postFlagConfigScheduledChanges

        public FeatureFlagScheduledChange postFlagConfigScheduledChanges​(java.lang.String projectKey,
                                                                 java.lang.String featureFlagKey,
                                                                 java.lang.String environmentKey,
                                                                 PostFlagScheduledChangesInput postFlagScheduledChangesInput,
                                                                 java.lang.Boolean ignoreConflicts)
                                                          throws ApiException
        Create scheduled changes workflow Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        postFlagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes (optional)
        Returns:
        FeatureFlagScheduledChange
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postFlagConfigScheduledChangesWithHttpInfo

        public ApiResponse<FeatureFlagScheduledChange> postFlagConfigScheduledChangesWithHttpInfo​(java.lang.String projectKey,
                                                                                          java.lang.String featureFlagKey,
                                                                                          java.lang.String environmentKey,
                                                                                          PostFlagScheduledChangesInput postFlagScheduledChangesInput,
                                                                                          java.lang.Boolean ignoreConflicts)
                                                                                   throws ApiException
        Create scheduled changes workflow Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        postFlagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes (optional)
        Returns:
        ApiResponse<FeatureFlagScheduledChange>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postFlagConfigScheduledChangesAsync

        public okhttp3.Call postFlagConfigScheduledChangesAsync​(java.lang.String projectKey,
                                                        java.lang.String featureFlagKey,
                                                        java.lang.String environmentKey,
                                                        PostFlagScheduledChangesInput postFlagScheduledChangesInput,
                                                        java.lang.Boolean ignoreConflicts,
                                                        ApiCallback<FeatureFlagScheduledChange> _callback)
                                                 throws ApiException
        Create scheduled changes workflow (asynchronously) Create scheduled changes for a feature flag. If the `ignoreConficts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.
        Parameters:
        projectKey - The project key (required)
        featureFlagKey - The feature flag key (required)
        environmentKey - The environment key (required)
        postFlagScheduledChangesInput - (required)
        ignoreConflicts - Whether to succeed (`true`) or fail (`false`) when these instructions conflict with existing scheduled changes (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