Class SegmentsBetaApi


  • public class SegmentsBetaApi
    extends java.lang.Object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createBigSegmentExport​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey)
      Create Big Segment export Starts a new export process for a Big Segment
      okhttp3.Call createBigSegmentExportAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, ApiCallback<java.lang.Void> _callback)
      Create Big Segment export (asynchronously) Starts a new export process for a Big Segment
      okhttp3.Call createBigSegmentExportCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, ApiCallback _callback)
      Build call for createBigSegmentExport
      ApiResponse<java.lang.Void> createBigSegmentExportWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey)
      Create Big Segment export Starts a new export process for a Big Segment
      void createBigSegmentImport​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.io.File _file, java.lang.String mode)
      Create Big Segment import Start a new import process for a Big Segment.
      okhttp3.Call createBigSegmentImportAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.io.File _file, java.lang.String mode, ApiCallback<java.lang.Void> _callback)
      Create Big Segment import (asynchronously) Start a new import process for a Big Segment.
      okhttp3.Call createBigSegmentImportCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.io.File _file, java.lang.String mode, ApiCallback _callback)
      Build call for createBigSegmentImport
      ApiResponse<java.lang.Void> createBigSegmentImportWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.io.File _file, java.lang.String mode)
      Create Big Segment import Start a new import process for a Big Segment.
      ApiClient getApiClient()  
      Export getBigSegmentExport​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String exportID)
      Get Big Segment export Returns info about a Big Segment export process.
      okhttp3.Call getBigSegmentExportAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String exportID, ApiCallback<Export> _callback)
      Get Big Segment export (asynchronously) Returns info about a Big Segment export process.
      okhttp3.Call getBigSegmentExportCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String exportID, ApiCallback _callback)
      Build call for getBigSegmentExport
      ApiResponse<Export> getBigSegmentExportWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String exportID)
      Get Big Segment export Returns info about a Big Segment export process.
      ModelImport getBigSegmentImport​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String importID)
      Get Big Segment import Returns info about a Big Segment import process.
      okhttp3.Call getBigSegmentImportAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String importID, ApiCallback<ModelImport> _callback)
      Get Big Segment import (asynchronously) Returns info about a Big Segment import process.
      okhttp3.Call getBigSegmentImportCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String importID, ApiCallback _callback)
      Build call for getBigSegmentImport
      ApiResponse<ModelImport> getBigSegmentImportWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String segmentKey, java.lang.String importID)
      Get Big Segment import Returns info about a Big Segment import process.
      java.lang.String getCustomBaseUrl()  
      int getHostIndex()  
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SegmentsBetaApi

        public SegmentsBetaApi()
      • SegmentsBetaApi

        public SegmentsBetaApi​(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)
      • createBigSegmentExportCall

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

        public void createBigSegmentExport​(java.lang.String projectKey,
                                           java.lang.String environmentKey,
                                           java.lang.String segmentKey)
                                    throws ApiException
        Create Big Segment export Starts a new export process for a Big Segment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • createBigSegmentExportWithHttpInfo

        public ApiResponse<java.lang.Void> createBigSegmentExportWithHttpInfo​(java.lang.String projectKey,
                                                                              java.lang.String environmentKey,
                                                                              java.lang.String segmentKey)
                                                                       throws ApiException
        Create Big Segment export Starts a new export process for a Big Segment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • createBigSegmentExportAsync

        public okhttp3.Call createBigSegmentExportAsync​(java.lang.String projectKey,
                                                        java.lang.String environmentKey,
                                                        java.lang.String segmentKey,
                                                        ApiCallback<java.lang.Void> _callback)
                                                 throws ApiException
        Create Big Segment export (asynchronously) Starts a new export process for a Big Segment
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment 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
      • createBigSegmentImportCall

        public okhttp3.Call createBigSegmentImportCall​(java.lang.String projectKey,
                                                       java.lang.String environmentKey,
                                                       java.lang.String segmentKey,
                                                       java.io.File _file,
                                                       java.lang.String mode,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for createBigSegmentImport
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        _file - CSV file containing keys (optional)
        mode - Import mode. Use either `merge` or `replace` (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • createBigSegmentImport

        public void createBigSegmentImport​(java.lang.String projectKey,
                                           java.lang.String environmentKey,
                                           java.lang.String segmentKey,
                                           java.io.File _file,
                                           java.lang.String mode)
                                    throws ApiException
        Create Big Segment import Start a new import process for a Big Segment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        _file - CSV file containing keys (optional)
        mode - Import mode. Use either `merge` or `replace` (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • createBigSegmentImportWithHttpInfo

        public ApiResponse<java.lang.Void> createBigSegmentImportWithHttpInfo​(java.lang.String projectKey,
                                                                              java.lang.String environmentKey,
                                                                              java.lang.String segmentKey,
                                                                              java.io.File _file,
                                                                              java.lang.String mode)
                                                                       throws ApiException
        Create Big Segment import Start a new import process for a Big Segment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        _file - CSV file containing keys (optional)
        mode - Import mode. Use either `merge` or `replace` (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • createBigSegmentImportAsync

        public okhttp3.Call createBigSegmentImportAsync​(java.lang.String projectKey,
                                                        java.lang.String environmentKey,
                                                        java.lang.String segmentKey,
                                                        java.io.File _file,
                                                        java.lang.String mode,
                                                        ApiCallback<java.lang.Void> _callback)
                                                 throws ApiException
        Create Big Segment import (asynchronously) Start a new import process for a Big Segment.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        _file - CSV file containing keys (optional)
        mode - Import mode. Use either `merge` or `replace` (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
      • getBigSegmentExportCall

        public okhttp3.Call getBigSegmentExportCall​(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String segmentKey,
                                                    java.lang.String exportID,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getBigSegmentExport
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        exportID - The export ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getBigSegmentExport

        public Export getBigSegmentExport​(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          java.lang.String segmentKey,
                                          java.lang.String exportID)
                                   throws ApiException
        Get Big Segment export Returns info about a Big Segment export process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        exportID - The export ID (required)
        Returns:
        Export
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getBigSegmentExportWithHttpInfo

        public ApiResponse<Export> getBigSegmentExportWithHttpInfo​(java.lang.String projectKey,
                                                                   java.lang.String environmentKey,
                                                                   java.lang.String segmentKey,
                                                                   java.lang.String exportID)
                                                            throws ApiException
        Get Big Segment export Returns info about a Big Segment export process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        exportID - The export ID (required)
        Returns:
        ApiResponse<Export>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getBigSegmentExportAsync

        public okhttp3.Call getBigSegmentExportAsync​(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String segmentKey,
                                                     java.lang.String exportID,
                                                     ApiCallback<Export> _callback)
                                              throws ApiException
        Get Big Segment export (asynchronously) Returns info about a Big Segment export process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        exportID - The export 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
      • getBigSegmentImportCall

        public okhttp3.Call getBigSegmentImportCall​(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String segmentKey,
                                                    java.lang.String importID,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getBigSegmentImport
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        importID - The import ID (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getBigSegmentImport

        public ModelImport getBigSegmentImport​(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               java.lang.String segmentKey,
                                               java.lang.String importID)
                                        throws ApiException
        Get Big Segment import Returns info about a Big Segment import process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        importID - The import ID (required)
        Returns:
        ModelImport
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getBigSegmentImportWithHttpInfo

        public ApiResponse<ModelImport> getBigSegmentImportWithHttpInfo​(java.lang.String projectKey,
                                                                        java.lang.String environmentKey,
                                                                        java.lang.String segmentKey,
                                                                        java.lang.String importID)
                                                                 throws ApiException
        Get Big Segment import Returns info about a Big Segment import process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        importID - The import ID (required)
        Returns:
        ApiResponse<ModelImport>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getBigSegmentImportAsync

        public okhttp3.Call getBigSegmentImportAsync​(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String segmentKey,
                                                     java.lang.String importID,
                                                     ApiCallback<ModelImport> _callback)
                                              throws ApiException
        Get Big Segment import (asynchronously) Returns info about a Big Segment import process.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        segmentKey - The segment key (required)
        importID - The import 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