View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.data.pipeline.core.task;
19  
20  import org.apache.shardingsphere.data.pipeline.core.task.progress.TaskProgress;
21  
22  import java.util.Collection;
23  import java.util.concurrent.CompletableFuture;
24  
25  /**
26   * Pipeline task interface.
27   */
28  public interface PipelineTask {
29      
30      /**
31       * Start task.
32       *
33       * @return future
34       */
35      Collection<CompletableFuture<?>> start();
36      
37      /**
38       * Stop task.
39       */
40      void stop();
41      
42      /**
43       * Get task id.
44       *
45       * @return task id
46       */
47      String getTaskId();
48      
49      /**
50       * Get task progress.
51       *
52       * @return task progress
53       */
54      TaskProgress getTaskProgress();
55  }