| <!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: AsyncBufferedMutatorBuilder"> |
| <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.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * For creating {@link AsyncBufferedMutator}.</span> |
| <span class="source-line-no">027</span><span id="line-27"> */</span> |
| <span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.Public</span> |
| <span class="source-line-no">029</span><span id="line-29">public interface AsyncBufferedMutatorBuilder {</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31"> /**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Set timeout for the background flush operation.</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34"> AsyncBufferedMutatorBuilder setOperationTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> /**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * Set timeout for each rpc request when doing background flush.</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39"> AsyncBufferedMutatorBuilder setRpcTimeout(long timeout, TimeUnit unit);</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> /**</span> |
| <span class="source-line-no">042</span><span id="line-42"> * Set the base pause time for retrying. We use an exponential policy to generate sleep time when</span> |
| <span class="source-line-no">043</span><span id="line-43"> * retrying.</span> |
| <span class="source-line-no">044</span><span id="line-44"> */</span> |
| <span class="source-line-no">045</span><span id="line-45"> AsyncBufferedMutatorBuilder setRetryPause(long pause, TimeUnit unit);</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Set the periodical flush interval. If the data in the buffer has not been flush for a long</span> |
| <span class="source-line-no">049</span><span id="line-49"> * time, i.e, reach this timeout limit, we will flush it automatically.</span> |
| <span class="source-line-no">050</span><span id="line-50"> * <p/></span> |
| <span class="source-line-no">051</span><span id="line-51"> * Notice that, set the timeout to 0 or a negative value means disable periodical flush, not</span> |
| <span class="source-line-no">052</span><span id="line-52"> * 'flush immediately'. If you want to flush immediately then you should not use this class, as it</span> |
| <span class="source-line-no">053</span><span id="line-53"> * is designed to be 'buffered'.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> default AsyncBufferedMutatorBuilder setWriteBufferPeriodicFlush(long timeout, TimeUnit unit) {</span> |
| <span class="source-line-no">056</span><span id="line-56"> throw new UnsupportedOperationException("Not implemented");</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"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Disable the periodical flush, i.e, set the timeout to 0.</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> default AsyncBufferedMutatorBuilder disableWriteBufferPeriodicFlush() {</span> |
| <span class="source-line-no">063</span><span id="line-63"> return setWriteBufferPeriodicFlush(0, TimeUnit.NANOSECONDS);</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</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 the max retry times for an operation. Usually it is the max attempt times minus 1.</span> |
| <span class="source-line-no">068</span><span id="line-68"> * <p></span> |
| <span class="source-line-no">069</span><span id="line-69"> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,</span> |
| <span class="source-line-no">070</span><span id="line-70"> * we will stop retrying when we reach any of the limitations.</span> |
| <span class="source-line-no">071</span><span id="line-71"> * @see #setMaxAttempts(int)</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @see #setOperationTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> default AsyncBufferedMutatorBuilder setMaxRetries(int maxRetries) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> return setMaxAttempts(retries2Attempts(maxRetries));</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> /**</span> |
| <span class="source-line-no">079</span><span id="line-79"> * Set the max attempt times for an operation. Usually it is the max retry times plus 1. Operation</span> |
| <span class="source-line-no">080</span><span id="line-80"> * timeout and max attempt times(or max retry times) are both limitations for retrying, we will</span> |
| <span class="source-line-no">081</span><span id="line-81"> * stop retrying when we reach any of the limitations.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @see #setMaxRetries(int)</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @see #setOperationTimeout(long, TimeUnit)</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> AsyncBufferedMutatorBuilder setMaxAttempts(int maxAttempts);</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Set the number of retries that are allowed before we start to log.</span> |
| <span class="source-line-no">089</span><span id="line-89"> */</span> |
| <span class="source-line-no">090</span><span id="line-90"> AsyncBufferedMutatorBuilder setStartLogErrorsCnt(int startLogErrorsCnt);</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /**</span> |
| <span class="source-line-no">093</span><span id="line-93"> * Override the write buffer size specified by the provided {@link AsyncConnection}'s</span> |
| <span class="source-line-no">094</span><span id="line-94"> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key</span> |
| <span class="source-line-no">095</span><span id="line-95"> * {@code hbase.client.write.buffer}.</span> |
| <span class="source-line-no">096</span><span id="line-96"> */</span> |
| <span class="source-line-no">097</span><span id="line-97"> AsyncBufferedMutatorBuilder setWriteBufferSize(long writeBufferSize);</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /**</span> |
| <span class="source-line-no">100</span><span id="line-100"> * Override the maximum key-value size specified by the provided {@link AsyncConnection}'s</span> |
| <span class="source-line-no">101</span><span id="line-101"> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key</span> |
| <span class="source-line-no">102</span><span id="line-102"> * {@code hbase.client.keyvalue.maxsize}.</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> AsyncBufferedMutatorBuilder setMaxKeyValueSize(int maxKeyValueSize);</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /**</span> |
| <span class="source-line-no">107</span><span id="line-107"> * Create the {@link AsyncBufferedMutator} instance.</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> AsyncBufferedMutator build();</span> |
| <span class="source-line-no">110</span><span id="line-110">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
