Class DataExportDestinationsApi


  • public class DataExportDestinationsApi
    extends java.lang.Object
    • Constructor Detail

      • DataExportDestinationsApi

        public DataExportDestinationsApi()
      • DataExportDestinationsApi

        public DataExportDestinationsApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • deleteDestinationCall

        public okhttp3.Call deleteDestinationCall​(java.lang.String projKey,
                                                  java.lang.String envKey,
                                                  java.lang.String id,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for deleteDestination
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • deleteDestination

        public void deleteDestination​(java.lang.String projKey,
                                      java.lang.String envKey,
                                      java.lang.String id)
                               throws ApiException
        Delete Data Export destination Delete Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteDestinationWithHttpInfo

        public ApiResponse<java.lang.Void> deleteDestinationWithHttpInfo​(java.lang.String projKey,
                                                                         java.lang.String envKey,
                                                                         java.lang.String id)
                                                                  throws ApiException
        Delete Data Export destination Delete Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • deleteDestinationAsync

        public okhttp3.Call deleteDestinationAsync​(java.lang.String projKey,
                                                   java.lang.String envKey,
                                                   java.lang.String id,
                                                   ApiCallback<java.lang.Void> _callback)
                                            throws ApiException
        Delete Data Export destination (asynchronously) Delete Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination 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
      • getDestinationCall

        public okhttp3.Call getDestinationCall​(java.lang.String projKey,
                                               java.lang.String envKey,
                                               java.lang.String id,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getDestination
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getDestination

        public Destination getDestination​(java.lang.String projKey,
                                          java.lang.String envKey,
                                          java.lang.String id)
                                   throws ApiException
        Get destination Get a single Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getDestinationWithHttpInfo

        public ApiResponse<Destination> getDestinationWithHttpInfo​(java.lang.String projKey,
                                                                   java.lang.String envKey,
                                                                   java.lang.String id)
                                                            throws ApiException
        Get destination Get a single Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getDestinationAsync

        public okhttp3.Call getDestinationAsync​(java.lang.String projKey,
                                                java.lang.String envKey,
                                                java.lang.String id,
                                                ApiCallback<Destination> _callback)
                                         throws ApiException
        Get destination (asynchronously) Get a single Data Export destination by ID
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination 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
      • getDestinationsCall

        public okhttp3.Call getDestinationsCall​(ApiCallback _callback)
                                         throws ApiException
        Build call for getDestinations
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getDestinations

        public Destinations getDestinations()
                                     throws ApiException
        List destinations Get a list of Data Export destinations configured across all projects and environments.
        Returns:
        Destinations
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getDestinationsWithHttpInfo

        public ApiResponse<Destinations> getDestinationsWithHttpInfo()
                                                              throws ApiException
        List destinations Get a list of Data Export destinations configured across all projects and environments.
        Returns:
        ApiResponse<Destinations>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getDestinationsAsync

        public okhttp3.Call getDestinationsAsync​(ApiCallback<Destinations> _callback)
                                          throws ApiException
        List destinations (asynchronously) Get a list of Data Export destinations configured across all projects and environments.
        Parameters:
        _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
      • patchDestinationCall

        public okhttp3.Call patchDestinationCall​(java.lang.String projKey,
                                                 java.lang.String envKey,
                                                 java.lang.String id,
                                                 java.util.List<PatchOperation> patchOperation,
                                                 ApiCallback _callback)
                                          throws ApiException
        Build call for patchDestination
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • patchDestination

        public Destination patchDestination​(java.lang.String projKey,
                                            java.lang.String envKey,
                                            java.lang.String id,
                                            java.util.List<PatchOperation> patchOperation)
                                     throws ApiException
        Update Data Export destination Update a Data Export destination. This requires a JSON Patch representation of the modified destination.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • patchDestinationWithHttpInfo

        public ApiResponse<Destination> patchDestinationWithHttpInfo​(java.lang.String projKey,
                                                                     java.lang.String envKey,
                                                                     java.lang.String id,
                                                                     java.util.List<PatchOperation> patchOperation)
                                                              throws ApiException
        Update Data Export destination Update a Data Export destination. This requires a JSON Patch representation of the modified destination.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • patchDestinationAsync

        public okhttp3.Call patchDestinationAsync​(java.lang.String projKey,
                                                  java.lang.String envKey,
                                                  java.lang.String id,
                                                  java.util.List<PatchOperation> patchOperation,
                                                  ApiCallback<Destination> _callback)
                                           throws ApiException
        Update Data Export destination (asynchronously) Update a Data Export destination. This requires a JSON Patch representation of the modified destination.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        id - The Data Export destination ID (required)
        patchOperation - (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
      • postDestinationCall

        public okhttp3.Call postDestinationCall​(java.lang.String projKey,
                                                java.lang.String envKey,
                                                DestinationPost destinationPost,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for postDestination
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        destinationPost - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • postDestination

        public Destination postDestination​(java.lang.String projKey,
                                           java.lang.String envKey,
                                           DestinationPost destinationPost)
                                    throws ApiException
        Create data export destination Create a new destination. The `config` body parameter represents the configuration parameters required for a destination type.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        destinationPost - (required)
        Returns:
        Destination
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postDestinationWithHttpInfo

        public ApiResponse<Destination> postDestinationWithHttpInfo​(java.lang.String projKey,
                                                                    java.lang.String envKey,
                                                                    DestinationPost destinationPost)
                                                             throws ApiException
        Create data export destination Create a new destination. The `config` body parameter represents the configuration parameters required for a destination type.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        destinationPost - (required)
        Returns:
        ApiResponse<Destination>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postDestinationAsync

        public okhttp3.Call postDestinationAsync​(java.lang.String projKey,
                                                 java.lang.String envKey,
                                                 DestinationPost destinationPost,
                                                 ApiCallback<Destination> _callback)
                                          throws ApiException
        Create data export destination (asynchronously) Create a new destination. The `config` body parameter represents the configuration parameters required for a destination type.
        Parameters:
        projKey - The project key (required)
        envKey - The environment key (required)
        destinationPost - (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