| <!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.client, interface: AsyncTableBuilder"> |
| <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.client;</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 static org.apache.hadoop.hbase.client.ConnectionUtils.retries2Attempts;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HBaseServerException;</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"> * For creating {@link AsyncTable}.</span> |
| <span class="source-line-no">028</span><span id="line-28"> * <p></span> |
| <span class="source-line-no">029</span><span id="line-29"> * The implementation should have default configurations set before returning the builder to user.</span> |
| <span class="source-line-no">030</span><span id="line-30"> * So users are free to only set the configs they care about to create a new</span> |
| <span class="source-line-no">031</span><span id="line-31"> * AsyncTable/RawAsyncTable instance.</span> |
| <span class="source-line-no">032</span><span id="line-32"> * @since 2.0.0</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Public</span> |
| <span class="source-line-no">035</span><span id="line-35">public interface AsyncTableBuilder<C extends ScanResultConsumerBase> {</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * Set timeout for a whole operation such as get, put or delete. Notice that scan will not be</span> |
| <span class="source-line-no">039</span><span id="line-39"> * effected by this value, see scanTimeoutNs.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * <p></span> |
| <span class="source-line-no">041</span><span id="line-41"> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,</span> |
| <span class="source-line-no">042</span><span id="line-42"> * we will stop retrying when we reach any of the limitations.</span> |
| <span class="source-line-no">043</span><span id="line-43"> * @see #setMaxAttempts(int)</span> |
| <span class="source-line-no">044</span><span id="line-44"> * @see #setMaxRetries(int)</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @see #setScanTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47"> AsyncTableBuilder<C> setOperationTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> /**</span> |
| <span class="source-line-no">050</span><span id="line-50"> * As now we have heartbeat support for scan, ideally a scan will never timeout unless the RS is</span> |
| <span class="source-line-no">051</span><span id="line-51"> * crash. The RS will always return something before the rpc timed out or scan timed out to tell</span> |
| <span class="source-line-no">052</span><span id="line-52"> * the client that it is still alive. The scan timeout is used as operation timeout for every</span> |
| <span class="source-line-no">053</span><span id="line-53"> * operation in a scan, such as openScanner or next.</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @see #setScanTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56"> AsyncTableBuilder<C> setScanTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Set timeout for each rpc request.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * <p></span> |
| <span class="source-line-no">061</span><span id="line-61"> * Notice that this will <strong>NOT</strong> change the rpc timeout for read(get, scan) request</span> |
| <span class="source-line-no">062</span><span id="line-62"> * and write request(put, delete).</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> AsyncTableBuilder<C> setRpcTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Set timeout for each read(get, scan) rpc request.</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> AsyncTableBuilder<C> setReadRpcTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Set timeout for each write(put, delete) rpc request.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> AsyncTableBuilder<C> setWriteRpcTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> /**</span> |
| <span class="source-line-no">077</span><span id="line-77"> * Set the base pause time for retrying. We use an exponential policy to generate sleep time when</span> |
| <span class="source-line-no">078</span><span id="line-78"> * retrying.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @see #setRetryPauseForServerOverloaded(long, TimeUnit)</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> AsyncTableBuilder<C> setRetryPause(long pause, TimeUnit unit);</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * Set the base pause time for retrying when {@link HBaseServerException#isServerOverloaded()}. We</span> |
| <span class="source-line-no">085</span><span id="line-85"> * use an exponential policy to generate sleep time when retrying.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * <p/></span> |
| <span class="source-line-no">087</span><span id="line-87"> * This value should be greater than the normal pause value which could be set with the above</span> |
| <span class="source-line-no">088</span><span id="line-88"> * {@link #setRetryPause(long, TimeUnit)} method, as usually</span> |
| <span class="source-line-no">089</span><span id="line-89"> * {@link HBaseServerException#isServerOverloaded()} means the server is overloaded. We just use</span> |
| <span class="source-line-no">090</span><span id="line-90"> * the normal pause value for {@link HBaseServerException#isServerOverloaded()} if here you</span> |
| <span class="source-line-no">091</span><span id="line-91"> * specify a smaller value.</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @see #setRetryPause(long, TimeUnit)</span> |
| <span class="source-line-no">093</span><span id="line-93"> * @deprecated Since 2.5.0, will be removed in 4.0.0. Please use</span> |
| <span class="source-line-no">094</span><span id="line-94"> * {@link #setRetryPauseForServerOverloaded(long, TimeUnit)} instead.</span> |
| <span class="source-line-no">095</span><span id="line-95"> */</span> |
| <span class="source-line-no">096</span><span id="line-96"> @Deprecated</span> |
| <span class="source-line-no">097</span><span id="line-97"> default AsyncTableBuilder<C> setRetryPauseForCQTBE(long pause, TimeUnit unit) {</span> |
| <span class="source-line-no">098</span><span id="line-98"> return setRetryPauseForServerOverloaded(pause, unit);</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> /**</span> |
| <span class="source-line-no">102</span><span id="line-102"> * Set the base pause time for retrying when {@link HBaseServerException#isServerOverloaded()}. We</span> |
| <span class="source-line-no">103</span><span id="line-103"> * use an exponential policy to generate sleep time when retrying.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * <p/></span> |
| <span class="source-line-no">105</span><span id="line-105"> * This value should be greater than the normal pause value which could be set with the above</span> |
| <span class="source-line-no">106</span><span id="line-106"> * {@link #setRetryPause(long, TimeUnit)} method, as usually</span> |
| <span class="source-line-no">107</span><span id="line-107"> * {@link HBaseServerException#isServerOverloaded()} means the server is overloaded. We just use</span> |
| <span class="source-line-no">108</span><span id="line-108"> * the normal pause value for {@link HBaseServerException#isServerOverloaded()} if here you</span> |
| <span class="source-line-no">109</span><span id="line-109"> * specify a smaller value.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @see #setRetryPause(long, TimeUnit)</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> AsyncTableBuilder<C> setRetryPauseForServerOverloaded(long pause, TimeUnit unit);</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * Set the max retry times for an operation. Usually it is the max attempt times minus 1.</span> |
| <span class="source-line-no">116</span><span id="line-116"> * <p></span> |
| <span class="source-line-no">117</span><span id="line-117"> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,</span> |
| <span class="source-line-no">118</span><span id="line-118"> * we will stop retrying when we reach any of the limitations.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @see #setMaxAttempts(int)</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @see #setOperationTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> default AsyncTableBuilder<C> setMaxRetries(int maxRetries) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> return setMaxAttempts(retries2Attempts(maxRetries));</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /**</span> |
| <span class="source-line-no">127</span><span id="line-127"> * Set the max attempt times for an operation. Usually it is the max retry times plus 1. Operation</span> |
| <span class="source-line-no">128</span><span id="line-128"> * timeout and max attempt times(or max retry times) are both limitations for retrying, we will</span> |
| <span class="source-line-no">129</span><span id="line-129"> * stop retrying when we reach any of the limitations.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @see #setMaxRetries(int)</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @see #setOperationTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> AsyncTableBuilder<C> setMaxAttempts(int maxAttempts);</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Set the number of retries that are allowed before we start to log.</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> AsyncTableBuilder<C> setStartLogErrorsCnt(int startLogErrorsCnt);</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> /**</span> |
| <span class="source-line-no">141</span><span id="line-141"> * Set a request attribute</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> AsyncTableBuilder<C> setRequestAttribute(String key, byte[] value);</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> /**</span> |
| <span class="source-line-no">146</span><span id="line-146"> * Create the {@link AsyncTable} instance.</span> |
| <span class="source-line-no">147</span><span id="line-147"> */</span> |
| <span class="source-line-no">148</span><span id="line-148"> AsyncTable<C> build();</span> |
| <span class="source-line-no">149</span><span id="line-149">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
