Package io.harness.cf.api

Class ClientApi

  • public class ClientApi
extends java.lang.Object

    • Constructor Detail

      • ClientApi

        public ClientApi()

      • ClientApi

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

      • authenticateCall

        public okhttp3.Call authenticateCall​(AuthenticationRequest authenticationRequest,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for authenticate
        Parameters:
        authenticationRequest - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • authenticate

        public AuthenticationResponse authenticate​(AuthenticationRequest authenticationRequest)
                                    throws ApiException
        Authenticate with the admin server. Used to retrieve all target segments for certain account id.
        Parameters:
        authenticationRequest - (optional)
        Returns:
        AuthenticationResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • authenticateWithHttpInfo

        public ApiResponse<AuthenticationResponse> authenticateWithHttpInfo​(AuthenticationRequest authenticationRequest)
                                                             throws ApiException
        Authenticate with the admin server. Used to retrieve all target segments for certain account id.
        Parameters:
        authenticationRequest - (optional)
        Returns:
        ApiResponse<AuthenticationResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • authenticateAsync

        public okhttp3.Call authenticateAsync​(AuthenticationRequest authenticationRequest,
                                      ApiCallback<AuthenticationResponse> _callback)
                               throws ApiException
        Authenticate with the admin server. (asynchronously) Used to retrieve all target segments for certain account id.
        Parameters:
        authenticationRequest - (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

      • getAllSegmentsCall

        public okhttp3.Call getAllSegmentsCall​(java.lang.String environmentUUID,
                                       java.lang.String cluster,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getAllSegments
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getAllSegments

        public java.util.List<Segment> getAllSegments​(java.lang.String environmentUUID,
                                              java.lang.String cluster)
                                       throws ApiException
        Retrieve all segments. Used to retrieve all segments for certain account id.
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        List<Segment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllSegmentsWithHttpInfo

        public ApiResponse<java.util.List<Segment>> getAllSegmentsWithHttpInfo​(java.lang.String environmentUUID,
                                                                       java.lang.String cluster)
                                                                throws ApiException
        Retrieve all segments. Used to retrieve all segments for certain account id.
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<List<Segment>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAllSegmentsAsync

        public okhttp3.Call getAllSegmentsAsync​(java.lang.String environmentUUID,
                                        java.lang.String cluster,
                                        ApiCallback<java.util.List<Segment>> _callback)
                                 throws ApiException
        Retrieve all segments. (asynchronously) Used to retrieve all segments for certain account id.
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (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

      • getEvaluationByIdentifierCall

        public okhttp3.Call getEvaluationByIdentifierCall​(java.lang.String environmentUUID,
                                                  java.lang.String feature,
                                                  java.lang.String target,
                                                  java.lang.String cluster,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getEvaluationByIdentifier
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        feature - Unique identifier for the flag object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEvaluationByIdentifier

        public Evaluation getEvaluationByIdentifier​(java.lang.String environmentUUID,
                                            java.lang.String feature,
                                            java.lang.String target,
                                            java.lang.String cluster)
                                     throws ApiException
        Get feature evaluations for target
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        feature - Unique identifier for the flag object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        Evaluation
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEvaluationByIdentifierWithHttpInfo

        public ApiResponse<Evaluation> getEvaluationByIdentifierWithHttpInfo​(java.lang.String environmentUUID,
                                                                     java.lang.String feature,
                                                                     java.lang.String target,
                                                                     java.lang.String cluster)
                                                              throws ApiException
        Get feature evaluations for target
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        feature - Unique identifier for the flag object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<Evaluation>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEvaluationByIdentifierAsync

        public okhttp3.Call getEvaluationByIdentifierAsync​(java.lang.String environmentUUID,
                                                   java.lang.String feature,
                                                   java.lang.String target,
                                                   java.lang.String cluster,
                                                   ApiCallback<Evaluation> _callback)
                                            throws ApiException
        Get feature evaluations for target (asynchronously)
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        feature - Unique identifier for the flag object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (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

      • getEvaluationsCall

        public okhttp3.Call getEvaluationsCall​(java.lang.String environmentUUID,
                                       java.lang.String target,
                                       java.lang.String cluster,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getEvaluations
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEvaluations

        public java.util.List getEvaluations​(java.lang.String environmentUUID,
                                     java.lang.String target,
                                     java.lang.String cluster)
                              throws ApiException
        Get feature evaluations for target
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        List
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEvaluationsWithHttpInfo

        public ApiResponse<java.util.List> getEvaluationsWithHttpInfo​(java.lang.String environmentUUID,
                                                              java.lang.String target,
                                                              java.lang.String cluster)
                                                       throws ApiException
        Get feature evaluations for target
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<List>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEvaluationsAsync

        public okhttp3.Call getEvaluationsAsync​(java.lang.String environmentUUID,
                                        java.lang.String target,
                                        java.lang.String cluster,
                                        ApiCallback<java.util.List> _callback)
                                 throws ApiException
        Get feature evaluations for target (asynchronously)
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        target - Unique identifier for the target object in the API. (required)
        cluster - Unique identifier for the cluster for the account (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

      • getFeatureConfigCall

        public okhttp3.Call getFeatureConfigCall​(java.lang.String environmentUUID,
                                         java.lang.String cluster,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getFeatureConfig
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFeatureConfig

        public java.util.List<FeatureConfig> getFeatureConfig​(java.lang.String environmentUUID,
                                                      java.lang.String cluster)
                                               throws ApiException
        Get all feature flags activations All feature flags with activations in project environment
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        List<FeatureConfig>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureConfigWithHttpInfo

        public ApiResponse<java.util.List<FeatureConfig>> getFeatureConfigWithHttpInfo​(java.lang.String environmentUUID,
                                                                               java.lang.String cluster)
                                                                        throws ApiException
        Get all feature flags activations All feature flags with activations in project environment
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<List<FeatureConfig>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureConfigAsync

        public okhttp3.Call getFeatureConfigAsync​(java.lang.String environmentUUID,
                                          java.lang.String cluster,
                                          ApiCallback<java.util.List<FeatureConfig>> _callback)
                                   throws ApiException
        Get all feature flags activations (asynchronously) All feature flags with activations in project environment
        Parameters:
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (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

      • getFeatureConfigByIdentifierCall

        public okhttp3.Call getFeatureConfigByIdentifierCall​(java.lang.String identifier,
                                                     java.lang.String environmentUUID,
                                                     java.lang.String cluster,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for getFeatureConfigByIdentifier
        Parameters:
        identifier - Unique identifier for the flag object in the API. (required)
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFeatureConfigByIdentifier

        public FeatureConfig getFeatureConfigByIdentifier​(java.lang.String identifier,
                                                  java.lang.String environmentUUID,
                                                  java.lang.String cluster)
                                           throws ApiException
        Get feature config
        Parameters:
        identifier - Unique identifier for the flag object in the API. (required)
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        FeatureConfig
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureConfigByIdentifierWithHttpInfo

        public ApiResponse<FeatureConfig> getFeatureConfigByIdentifierWithHttpInfo​(java.lang.String identifier,
                                                                           java.lang.String environmentUUID,
                                                                           java.lang.String cluster)
                                                                    throws ApiException
        Get feature config
        Parameters:
        identifier - Unique identifier for the flag object in the API. (required)
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<FeatureConfig>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFeatureConfigByIdentifierAsync

        public okhttp3.Call getFeatureConfigByIdentifierAsync​(java.lang.String identifier,
                                                      java.lang.String environmentUUID,
                                                      java.lang.String cluster,
                                                      ApiCallback<FeatureConfig> _callback)
                                               throws ApiException
        Get feature config (asynchronously)
        Parameters:
        identifier - Unique identifier for the flag object in the API. (required)
        environmentUUID - Unique identifier for the environment object in the API. (required)
        cluster - Unique identifier for the cluster for the account (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

      • getSegmentByIdentifierCall

        public okhttp3.Call getSegmentByIdentifierCall​(java.lang.String identifier,
                                               java.lang.String environmentUUID,
                                               java.lang.String cluster,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getSegmentByIdentifier
        Parameters:
        identifier - Unique identifier for the segment object in the API (required)
        environmentUUID - Unique identifier for the environment object in the API (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getSegmentByIdentifier

        public Segment getSegmentByIdentifier​(java.lang.String identifier,
                                      java.lang.String environmentUUID,
                                      java.lang.String cluster)
                               throws ApiException
        Retrieve a segment by identifier Used to retrieve a segment for a certain account id by identifier
        Parameters:
        identifier - Unique identifier for the segment object in the API (required)
        environmentUUID - Unique identifier for the environment object in the API (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        Segment
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSegmentByIdentifierWithHttpInfo

        public ApiResponse<Segment> getSegmentByIdentifierWithHttpInfo​(java.lang.String identifier,
                                                               java.lang.String environmentUUID,
                                                               java.lang.String cluster)
                                                        throws ApiException
        Retrieve a segment by identifier Used to retrieve a segment for a certain account id by identifier
        Parameters:
        identifier - Unique identifier for the segment object in the API (required)
        environmentUUID - Unique identifier for the environment object in the API (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<Segment>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSegmentByIdentifierAsync

        public okhttp3.Call getSegmentByIdentifierAsync​(java.lang.String identifier,
                                                java.lang.String environmentUUID,
                                                java.lang.String cluster,
                                                ApiCallback<Segment> _callback)
                                         throws ApiException
        Retrieve a segment by identifier (asynchronously) Used to retrieve a segment for a certain account id by identifier
        Parameters:
        identifier - Unique identifier for the segment object in the API (required)
        environmentUUID - Unique identifier for the environment object in the API (required)
        cluster - Unique identifier for the cluster for the account (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

      • streamCall

        public okhttp3.Call streamCall​(java.lang.String apIKey,
                               java.lang.String cluster,
                               ApiCallback _callback)
                        throws ApiException
        Build call for stream
        Parameters:
        apIKey - (required)
        cluster - Unique identifier for the cluster for the account (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • stream

        public void stream​(java.lang.String apIKey,
                   java.lang.String cluster)
            throws ApiException
        Stream endpoint.
        Parameters:
        apIKey - (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • streamWithHttpInfo

        public ApiResponse<java.lang.Void> streamWithHttpInfo​(java.lang.String apIKey,
                                                      java.lang.String cluster)
                                               throws ApiException
        Stream endpoint.
        Parameters:
        apIKey - (required)
        cluster - Unique identifier for the cluster for the account (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • streamAsync

        public okhttp3.Call streamAsync​(java.lang.String apIKey,
                                java.lang.String cluster,
                                ApiCallback<java.lang.Void> _callback)
                         throws ApiException
        Stream endpoint. (asynchronously)
        Parameters:
        apIKey - (required)
        cluster - Unique identifier for the cluster for the account (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