| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.backup, interface: BackupCopyJob"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.backup;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.conf.Configurable;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.backup.impl.BackupManager;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25"></span> |
| <span class="source-line-no">026</span><span id="line-26">/**</span> |
| <span class="source-line-no">027</span><span id="line-27"> * Backup copy job is a part of a backup process. The concrete implementation is responsible for</span> |
| <span class="source-line-no">028</span><span id="line-28"> * copying data from a cluster to backup destination. Concrete implementation is provided by backup</span> |
| <span class="source-line-no">029</span><span id="line-29"> * provider, see {@link BackupRestoreFactory}</span> |
| <span class="source-line-no">030</span><span id="line-30"> */</span> |
| <span class="source-line-no">031</span><span id="line-31">@InterfaceAudience.Private</span> |
| <span class="source-line-no">032</span><span id="line-32">public interface BackupCopyJob extends Configurable {</span> |
| <span class="source-line-no">033</span><span id="line-33"> /**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Copy backup data to destination</span> |
| <span class="source-line-no">035</span><span id="line-35"> * @param backupInfo context object</span> |
| <span class="source-line-no">036</span><span id="line-36"> * @param backupManager backup manager</span> |
| <span class="source-line-no">037</span><span id="line-37"> * @param conf configuration</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @param backupType backup type (FULL or INCREMENTAL)</span> |
| <span class="source-line-no">039</span><span id="line-39"> * @param options array of options (implementation-specific)</span> |
| <span class="source-line-no">040</span><span id="line-40"> * @return result (0 - success, -1 failure )</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @throws IOException exception</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43"> int copy(BackupInfo backupInfo, BackupManager backupManager, Configuration conf,</span> |
| <span class="source-line-no">044</span><span id="line-44"> BackupType backupType, String[] options) throws IOException;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * Cancel copy job</span> |
| <span class="source-line-no">048</span><span id="line-48"> * @param jobHandler backup copy job handler</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @throws IOException if cancelling the jobs fails</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> void cancel(String jobHandler) throws IOException;</span> |
| <span class="source-line-no">052</span><span id="line-52">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
