shardingsphere-ui-backend/src/main/java/org/apache/shardingsphere/ui/servcie/forward/ShardingScalingForwardService.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.shardingsphere.ui.servcie.forward;

/**
 * Forward server of sharding scaling.
 */
public interface ShardingScalingForwardService {
    
    /**
     * list all sharding scaling jobs.
     *
     * @return response string from sharding scaling server
     */
    String listAllShardingScalingJobs();
    
    /**
     * Start sharding scaling job.
     *
     * @param requestBody request body of start sharding scaling job
     * @return response string from sharding scaling server
     */
    String startShardingScalingJobs(String requestBody);
    
    /**
     * Get sharding scaling job progress.
     *
     * @param jobId job id
     * @return response string from sharding scaling server
     */
    String getShardingScalingJobProgress(long jobId);
    
    /**
     * Stop sharding scaling job.
     *
     * @param jobId job id
     * @return response string from sharding scaling server
     */
    String stopShardingScalingJob(long jobId);
}