Package com.configcat.publicapi.java.client.api

Class EnvironmentsApi

  • public class EnvironmentsApi
extends java.lang.Object

    • Constructor Detail

      • EnvironmentsApi

        public EnvironmentsApi()

      • EnvironmentsApi

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

      • createEnvironmentCall

        public okhttp3.Call createEnvironmentCall​(java.util.UUID productId,
                                          CreateEnvironmentModel createEnvironmentModel,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for createEnvironment
        Parameters:
        productId - The identifier of the Product. (required)
        createEnvironmentModel - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • createEnvironment

        public EnvironmentModel createEnvironment​(java.util.UUID productId,
                                          CreateEnvironmentModel createEnvironmentModel)
                                   throws ApiException
        Create Environment This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        createEnvironmentModel - (required)
        Returns:
        EnvironmentModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • createEnvironmentWithHttpInfo

        public ApiResponse<EnvironmentModel> createEnvironmentWithHttpInfo​(java.util.UUID productId,
                                                                   CreateEnvironmentModel createEnvironmentModel)
                                                            throws ApiException
        Create Environment This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        createEnvironmentModel - (required)
        Returns:
        ApiResponse<EnvironmentModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • createEnvironmentAsync

        public okhttp3.Call createEnvironmentAsync​(java.util.UUID productId,
                                           CreateEnvironmentModel createEnvironmentModel,
                                           ApiCallback<EnvironmentModel> _callback)
                                    throws ApiException
        Create Environment (asynchronously) This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        createEnvironmentModel - (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
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • deleteEnvironmentCall

        public okhttp3.Call deleteEnvironmentCall​(java.util.UUID environmentId,
                                          java.lang.Boolean cleanupAuditLogs,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for deleteEnvironment
        Parameters:
        environmentId - The identifier of the Environment. (required)
        cleanupAuditLogs - An optional flag which indicates whether the audit log records related to the environment should be deleted or not. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • deleteEnvironment

        public void deleteEnvironment​(java.util.UUID environmentId,
                              java.lang.Boolean cleanupAuditLogs)
                       throws ApiException
        Delete Environment This endpoint removes an Environment identified by the `environmentId` parameter. If the `cleanupAuditLogs` flag is set to true, it also deletes the audit log records related to the environment (except for the `Created a new environment` and `Deleted an environment` records).
        Parameters:
        environmentId - The identifier of the Environment. (required)
        cleanupAuditLogs - An optional flag which indicates whether the audit log records related to the environment should be deleted or not. (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • deleteEnvironmentWithHttpInfo

        public ApiResponse<java.lang.Void> deleteEnvironmentWithHttpInfo​(java.util.UUID environmentId,
                                                                 java.lang.Boolean cleanupAuditLogs)
                                                          throws ApiException
        Delete Environment This endpoint removes an Environment identified by the `environmentId` parameter. If the `cleanupAuditLogs` flag is set to true, it also deletes the audit log records related to the environment (except for the `Created a new environment` and `Deleted an environment` records).
        Parameters:
        environmentId - The identifier of the Environment. (required)
        cleanupAuditLogs - An optional flag which indicates whether the audit log records related to the environment should be deleted or not. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • deleteEnvironmentAsync

        public okhttp3.Call deleteEnvironmentAsync​(java.util.UUID environmentId,
                                           java.lang.Boolean cleanupAuditLogs,
                                           ApiCallback<java.lang.Void> _callback)
                                    throws ApiException
        Delete Environment (asynchronously) This endpoint removes an Environment identified by the `environmentId` parameter. If the `cleanupAuditLogs` flag is set to true, it also deletes the audit log records related to the environment (except for the `Created a new environment` and `Deleted an environment` records).
        Parameters:
        environmentId - The identifier of the Environment. (required)
        cleanupAuditLogs - An optional flag which indicates whether the audit log records related to the environment should be deleted or not. (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
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentCall

        public okhttp3.Call getEnvironmentCall​(java.util.UUID environmentId,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getEnvironment
        Parameters:
        environmentId - The identifier of the Environment. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the environment data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironment

        public EnvironmentModel getEnvironment​(java.util.UUID environmentId)
                                throws ApiException
        Get Environment This endpoint returns the metadata of an Environment identified by the `environmentId`.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        Returns:
        EnvironmentModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the environment data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentWithHttpInfo

        public ApiResponse<EnvironmentModel> getEnvironmentWithHttpInfo​(java.util.UUID environmentId)
                                                         throws ApiException
        Get Environment This endpoint returns the metadata of an Environment identified by the `environmentId`.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        Returns:
        ApiResponse<EnvironmentModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the environment data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentAsync

        public okhttp3.Call getEnvironmentAsync​(java.util.UUID environmentId,
                                        ApiCallback<EnvironmentModel> _callback)
                                 throws ApiException
        Get Environment (asynchronously) This endpoint returns the metadata of an Environment identified by the `environmentId`.
        Parameters:
        environmentId - The identifier of the Environment. (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
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the environment data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentsCall

        public okhttp3.Call getEnvironmentsCall​(java.util.UUID productId,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getEnvironments
        Parameters:
        productId - The identifier of the Product. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironments

        public java.util.List<EnvironmentModel> getEnvironments​(java.util.UUID productId)
                                                 throws ApiException
        List Environments This endpoint returns the list of the Environments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        Returns:
        List<EnvironmentModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentsWithHttpInfo

        public ApiResponse<java.util.List<EnvironmentModel>> getEnvironmentsWithHttpInfo​(java.util.UUID productId)
                                                                          throws ApiException
        List Environments This endpoint returns the list of the Environments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        Returns:
        ApiResponse<List<EnvironmentModel>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • getEnvironmentsAsync

        public okhttp3.Call getEnvironmentsAsync​(java.util.UUID productId,
                                         ApiCallback<java.util.List<EnvironmentModel>> _callback)
                                  throws ApiException
        List Environments (asynchronously) This endpoint returns the list of the Environments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (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
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateEnvironmentCall

        public okhttp3.Call updateEnvironmentCall​(java.util.UUID environmentId,
                                          UpdateEnvironmentModel updateEnvironmentModel,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for updateEnvironment
        Parameters:
        environmentId - The identifier of the Environment. (required)
        updateEnvironmentModel - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateEnvironment

        public EnvironmentModel updateEnvironment​(java.util.UUID environmentId,
                                          UpdateEnvironmentModel updateEnvironmentModel)
                                   throws ApiException
        Update Environment This endpoint updates an Environment identified by the `environmentId` parameter.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        updateEnvironmentModel - (required)
        Returns:
        EnvironmentModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateEnvironmentWithHttpInfo

        public ApiResponse<EnvironmentModel> updateEnvironmentWithHttpInfo​(java.util.UUID environmentId,
                                                                   UpdateEnvironmentModel updateEnvironmentModel)
                                                            throws ApiException
        Update Environment This endpoint updates an Environment identified by the `environmentId` parameter.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        updateEnvironmentModel - (required)
        Returns:
        ApiResponse<EnvironmentModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -

      • updateEnvironmentAsync

        public okhttp3.Call updateEnvironmentAsync​(java.util.UUID environmentId,
                                           UpdateEnvironmentModel updateEnvironmentModel,
                                           ApiCallback<EnvironmentModel> _callback)
                                    throws ApiException
        Update Environment (asynchronously) This endpoint updates an Environment identified by the `environmentId` parameter.
        Parameters:
        environmentId - The identifier of the Environment. (required)
        updateEnvironmentModel - (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
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -