Package org.openapitools.client.api

Class MigrationApi

  • public class MigrationApi
extends Object

    • Constructor Detail

      • MigrationApi

        public MigrationApi()

      • MigrationApi

        public MigrationApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • executeMigrationPlanCall

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

      • executeMigrationPlan

        public void executeMigrationPlan​(MigrationExecutionDto migrationExecutionDto)
                          throws ApiException
        Execute Migration Plan Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the [Execute Migration Plan Async(Batch)](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration-async/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeMigrationPlanWithHttpInfo

        public ApiResponse<Void> executeMigrationPlanWithHttpInfo​(MigrationExecutionDto migrationExecutionDto)
                                                   throws ApiException
        Execute Migration Plan Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the [Execute Migration Plan Async(Batch)](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration-async/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeMigrationPlanAsync

        public okhttp3.Call executeMigrationPlanAsync​(MigrationExecutionDto migrationExecutionDto,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Execute Migration Plan (asynchronously) Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the [Execute Migration Plan Async(Batch)](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration-async/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (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

      • executeMigrationPlanAsyncCall

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

      • executeMigrationPlanAsync

        public BatchDto executeMigrationPlanAsync​(MigrationExecutionDto migrationExecutionDto)
                                   throws ApiException
        Execute Migration Plan Async (Batch) Executes a migration plan asynchronously (batch) for multiple process instances. To execute a migration plan synchronously, use the [Execute MigrationPlan](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (optional)
        Returns:
        BatchDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeMigrationPlanAsyncWithHttpInfo

        public ApiResponse<BatchDto> executeMigrationPlanAsyncWithHttpInfo​(MigrationExecutionDto migrationExecutionDto)
                                                            throws ApiException
        Execute Migration Plan Async (Batch) Executes a migration plan asynchronously (batch) for multiple process instances. To execute a migration plan synchronously, use the [Execute MigrationPlan](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (optional)
        Returns:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeMigrationPlanAsyncAsync

        public okhttp3.Call executeMigrationPlanAsyncAsync​(MigrationExecutionDto migrationExecutionDto,
                                                   ApiCallback<BatchDto> _callback)
                                            throws ApiException
        Execute Migration Plan Async (Batch) (asynchronously) Executes a migration plan asynchronously (batch) for multiple process instances. To execute a migration plan synchronously, use the [Execute MigrationPlan](https://docs.camunda.org/manual/7.18/reference/rest/migration/execute-migration/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
        Parameters:
        migrationExecutionDto - (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

      • generateMigrationPlanCall

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

      • generateMigrationPlan

        public MigrationPlanDto generateMigrationPlan​(MigrationPlanGenerationDto migrationPlanGenerationDto)
                                       throws ApiException
        Generate Migration Plan Generates a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.
        Parameters:
        migrationPlanGenerationDto - (optional)
        Returns:
        MigrationPlanDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • generateMigrationPlanWithHttpInfo

        public ApiResponse<MigrationPlanDto> generateMigrationPlanWithHttpInfo​(MigrationPlanGenerationDto migrationPlanGenerationDto)
                                                                throws ApiException
        Generate Migration Plan Generates a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.
        Parameters:
        migrationPlanGenerationDto - (optional)
        Returns:
        ApiResponse<MigrationPlanDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • generateMigrationPlanAsync

        public okhttp3.Call generateMigrationPlanAsync​(MigrationPlanGenerationDto migrationPlanGenerationDto,
                                               ApiCallback<MigrationPlanDto> _callback)
                                        throws ApiException
        Generate Migration Plan (asynchronously) Generates a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.
        Parameters:
        migrationPlanGenerationDto - (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

      • validateMigrationPlanCall

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

      • validateMigrationPlan

        public MigrationPlanReportDto validateMigrationPlan​(MigrationPlanDto migrationPlanDto)
                                             throws ApiException
        Validate Migration Plan Validates a migration plan statically without executing it. This corresponds to the [creation time validation](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#creation-time-validation) described in the user guide.
        Parameters:
        migrationPlanDto - (optional)
        Returns:
        MigrationPlanReportDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateMigrationPlanWithHttpInfo

        public ApiResponse<MigrationPlanReportDto> validateMigrationPlanWithHttpInfo​(MigrationPlanDto migrationPlanDto)
                                                                      throws ApiException
        Validate Migration Plan Validates a migration plan statically without executing it. This corresponds to the [creation time validation](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#creation-time-validation) described in the user guide.
        Parameters:
        migrationPlanDto - (optional)
        Returns:
        ApiResponse<MigrationPlanReportDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateMigrationPlanAsync

        public okhttp3.Call validateMigrationPlanAsync​(MigrationPlanDto migrationPlanDto,
                                               ApiCallback<MigrationPlanReportDto> _callback)
                                        throws ApiException
        Validate Migration Plan (asynchronously) Validates a migration plan statically without executing it. This corresponds to the [creation time validation](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration/#creation-time-validation) described in the user guide.
        Parameters:
        migrationPlanDto - (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