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.io.Closeable;
23  import java.util.Collection;
24  import java.util.concurrent.CompletableFuture;
25  
26  /**
27   * Pipeline task interface.
28   */
29  public interface PipelineTask extends Closeable {
30      
31      /**
32       * Start task.
33       *
34       * @return future
35       */
36      Collection<CompletableFuture<?>> start();
37      
38      /**
39       * Stop task.
40       */
41      void stop();
42      
43      /**
44       * Get task id.
45       *
46       * @return task id
47       */
48      String getTaskId();
49      
50      /**
51       * Get task progress.
52       *
53       * @return task progress
54       */
55      TaskProgress getTaskProgress();
56      
57      /**
58       * Close.
59       */
60      void close();
61  }