Google Git
Sign in
apache / hbase-site / e5d2e6a6f9646196617268912ffe3d020e593a18 / . / apidocs / src-html / org / apache / hadoop / hbase / client / BufferedMutatorParams.html
blob: df7ea55e9fb804dafef9de39888a942f7b528212 [file] [log] [blame]
<!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, class: BufferedMutatorParams">
<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 java.util.concurrent.ExecutorService;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">/**</span>
<span class="source-line-no">025</span><span id="line-25"> * Parameters for instantiating a {@link BufferedMutator}.</span>
<span class="source-line-no">026</span><span id="line-26"> */</span>
<span class="source-line-no">027</span><span id="line-27">@InterfaceAudience.Public</span>
<span class="source-line-no">028</span><span id="line-28">public class BufferedMutatorParams implements Cloneable {</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30"> static final int UNSET = -1;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> private final TableName tableName;</span>
<span class="source-line-no">033</span><span id="line-33"> private long writeBufferSize = UNSET;</span>
<span class="source-line-no">034</span><span id="line-34"> private long writeBufferPeriodicFlushTimeoutMs = UNSET;</span>
<span class="source-line-no">035</span><span id="line-35"> private long writeBufferPeriodicFlushTimerTickMs = UNSET;</span>
<span class="source-line-no">036</span><span id="line-36"> private int maxKeyValueSize = UNSET;</span>
<span class="source-line-no">037</span><span id="line-37"> private ExecutorService pool = null;</span>
<span class="source-line-no">038</span><span id="line-38"> private String implementationClassName = null;</span>
<span class="source-line-no">039</span><span id="line-39"> private int rpcTimeout = UNSET;</span>
<span class="source-line-no">040</span><span id="line-40"> private int operationTimeout = UNSET;</span>
<span class="source-line-no">041</span><span id="line-41"> private BufferedMutator.ExceptionListener listener = new BufferedMutator.ExceptionListener() {</span>
<span class="source-line-no">042</span><span id="line-42"> @Override</span>
<span class="source-line-no">043</span><span id="line-43"> public void onException(RetriesExhaustedWithDetailsException exception,</span>
<span class="source-line-no">044</span><span id="line-44"> BufferedMutator bufferedMutator) throws RetriesExhaustedWithDetailsException {</span>
<span class="source-line-no">045</span><span id="line-45"> throw exception;</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"></span>
<span class="source-line-no">049</span><span id="line-49"> public BufferedMutatorParams(TableName tableName) {</span>
<span class="source-line-no">050</span><span id="line-50"> this.tableName = tableName;</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> public TableName getTableName() {</span>
<span class="source-line-no">054</span><span id="line-54"> return tableName;</span>
<span class="source-line-no">055</span><span id="line-55"> }</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> public long getWriteBufferSize() {</span>
<span class="source-line-no">058</span><span id="line-58"> return writeBufferSize;</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> public BufferedMutatorParams rpcTimeout(final int rpcTimeout) {</span>
<span class="source-line-no">062</span><span id="line-62"> this.rpcTimeout = rpcTimeout;</span>
<span class="source-line-no">063</span><span id="line-63"> return this;</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"> public int getRpcTimeout() {</span>
<span class="source-line-no">067</span><span id="line-67"> return rpcTimeout;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> public BufferedMutatorParams operationTimeout(final int operationTimeout) {</span>
<span class="source-line-no">071</span><span id="line-71"> this.operationTimeout = operationTimeout;</span>
<span class="source-line-no">072</span><span id="line-72"> return this;</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> /**</span>
<span class="source-line-no">076</span><span id="line-76"> * @deprecated Since 2.3.0, will be removed in 4.0.0. Use {@link #operationTimeout(int)}</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> @Deprecated</span>
<span class="source-line-no">079</span><span id="line-79"> public BufferedMutatorParams opertationTimeout(final int operationTimeout) {</span>
<span class="source-line-no">080</span><span id="line-80"> this.operationTimeout = operationTimeout;</span>
<span class="source-line-no">081</span><span id="line-81"> return this;</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"> public int getOperationTimeout() {</span>
<span class="source-line-no">085</span><span id="line-85"> return operationTimeout;</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"> /**</span>
<span class="source-line-no">089</span><span id="line-89"> * Override the write buffer size specified by the provided {@link Connection}'s</span>
<span class="source-line-no">090</span><span id="line-90"> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key</span>
<span class="source-line-no">091</span><span id="line-91"> * {@code hbase.client.write.buffer}.</span>
<span class="source-line-no">092</span><span id="line-92"> */</span>
<span class="source-line-no">093</span><span id="line-93"> public BufferedMutatorParams writeBufferSize(long writeBufferSize) {</span>
<span class="source-line-no">094</span><span id="line-94"> this.writeBufferSize = writeBufferSize;</span>
<span class="source-line-no">095</span><span id="line-95"> return this;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> public long getWriteBufferPeriodicFlushTimeoutMs() {</span>
<span class="source-line-no">099</span><span id="line-99"> return writeBufferPeriodicFlushTimeoutMs;</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"> /**</span>
<span class="source-line-no">103</span><span id="line-103"> * Set the max timeout before the buffer is automatically flushed.</span>
<span class="source-line-no">104</span><span id="line-104"> */</span>
<span class="source-line-no">105</span><span id="line-105"> public BufferedMutatorParams setWriteBufferPeriodicFlushTimeoutMs(long timeoutMs) {</span>
<span class="source-line-no">106</span><span id="line-106"> this.writeBufferPeriodicFlushTimeoutMs = timeoutMs;</span>
<span class="source-line-no">107</span><span id="line-107"> return this;</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> /**</span>
<span class="source-line-no">111</span><span id="line-111"> * @deprecated Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client</span>
<span class="source-line-no">112</span><span id="line-112"> * implementation so you can not set it any more.</span>
<span class="source-line-no">113</span><span id="line-113"> */</span>
<span class="source-line-no">114</span><span id="line-114"> @Deprecated</span>
<span class="source-line-no">115</span><span id="line-115"> public long getWriteBufferPeriodicFlushTimerTickMs() {</span>
<span class="source-line-no">116</span><span id="line-116"> return writeBufferPeriodicFlushTimerTickMs;</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> /**</span>
<span class="source-line-no">120</span><span id="line-120"> * Set the TimerTick how often the buffer timeout if checked.</span>
<span class="source-line-no">121</span><span id="line-121"> * @deprecated Since 3.0.0, will be removed in 4.0.0. We use a common timer in the whole client</span>
<span class="source-line-no">122</span><span id="line-122"> * implementation so you can not set it any more.</span>
<span class="source-line-no">123</span><span id="line-123"> */</span>
<span class="source-line-no">124</span><span id="line-124"> @Deprecated</span>
<span class="source-line-no">125</span><span id="line-125"> public BufferedMutatorParams setWriteBufferPeriodicFlushTimerTickMs(long timerTickMs) {</span>
<span class="source-line-no">126</span><span id="line-126"> this.writeBufferPeriodicFlushTimerTickMs = timerTickMs;</span>
<span class="source-line-no">127</span><span id="line-127"> return this;</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> public int getMaxKeyValueSize() {</span>
<span class="source-line-no">131</span><span id="line-131"> return maxKeyValueSize;</span>
<span class="source-line-no">132</span><span id="line-132"> }</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> /**</span>
<span class="source-line-no">135</span><span id="line-135"> * Override the maximum key-value size specified by the provided {@link Connection}'s</span>
<span class="source-line-no">136</span><span id="line-136"> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key</span>
<span class="source-line-no">137</span><span id="line-137"> * {@code hbase.client.keyvalue.maxsize}.</span>
<span class="source-line-no">138</span><span id="line-138"> */</span>
<span class="source-line-no">139</span><span id="line-139"> public BufferedMutatorParams maxKeyValueSize(int maxKeyValueSize) {</span>
<span class="source-line-no">140</span><span id="line-140"> this.maxKeyValueSize = maxKeyValueSize;</span>
<span class="source-line-no">141</span><span id="line-141"> return this;</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> /**</span>
<span class="source-line-no">145</span><span id="line-145"> * @deprecated Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore.</span>
<span class="source-line-no">146</span><span id="line-146"> * BufferedMutator will use Connection's ExecutorService.</span>
<span class="source-line-no">147</span><span id="line-147"> */</span>
<span class="source-line-no">148</span><span id="line-148"> @Deprecated</span>
<span class="source-line-no">149</span><span id="line-149"> public ExecutorService getPool() {</span>
<span class="source-line-no">150</span><span id="line-150"> return pool;</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> /**</span>
<span class="source-line-no">154</span><span id="line-154"> * Override the default executor pool defined by the {@code hbase.htable.threads.*} configuration</span>
<span class="source-line-no">155</span><span id="line-155"> * values.</span>
<span class="source-line-no">156</span><span id="line-156"> * @deprecated Since 3.0.0-alpha-2, will be removed in 4.0.0. You can not set it anymore.</span>
<span class="source-line-no">157</span><span id="line-157"> * BufferedMutator will use Connection's ExecutorService.</span>
<span class="source-line-no">158</span><span id="line-158"> */</span>
<span class="source-line-no">159</span><span id="line-159"> @Deprecated</span>
<span class="source-line-no">160</span><span id="line-160"> public BufferedMutatorParams pool(ExecutorService pool) {</span>
<span class="source-line-no">161</span><span id="line-161"> this.pool = pool;</span>
<span class="source-line-no">162</span><span id="line-162"> return this;</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> /**</span>
<span class="source-line-no">166</span><span id="line-166"> * @return Name of the class we will use when we construct a {@link BufferedMutator} instance or</span>
<span class="source-line-no">167</span><span id="line-167"> * null if default implementation.</span>
<span class="source-line-no">168</span><span id="line-168"> * @deprecated Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the</span>
<span class="source-line-no">169</span><span id="line-169"> * implementation has to use too many internal stuffs in HBase.</span>
<span class="source-line-no">170</span><span id="line-170"> */</span>
<span class="source-line-no">171</span><span id="line-171"> @Deprecated</span>
<span class="source-line-no">172</span><span id="line-172"> public String getImplementationClassName() {</span>
<span class="source-line-no">173</span><span id="line-173"> return this.implementationClassName;</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> /**</span>
<span class="source-line-no">177</span><span id="line-177"> * Specify a BufferedMutator implementation other than the default.</span>
<span class="source-line-no">178</span><span id="line-178"> * @param implementationClassName Name of the BufferedMutator implementation class</span>
<span class="source-line-no">179</span><span id="line-179"> * @deprecated Since 3.0.0, will be removed in 4.0.0. You can not set it any more as the</span>
<span class="source-line-no">180</span><span id="line-180"> * implementation has to use too many internal stuffs in HBase.</span>
<span class="source-line-no">181</span><span id="line-181"> */</span>
<span class="source-line-no">182</span><span id="line-182"> @Deprecated</span>
<span class="source-line-no">183</span><span id="line-183"> public BufferedMutatorParams implementationClassName(String implementationClassName) {</span>
<span class="source-line-no">184</span><span id="line-184"> this.implementationClassName = implementationClassName;</span>
<span class="source-line-no">185</span><span id="line-185"> return this;</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> public BufferedMutator.ExceptionListener getListener() {</span>
<span class="source-line-no">189</span><span id="line-189"> return listener;</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"></span>
<span class="source-line-no">192</span><span id="line-192"> /**</span>
<span class="source-line-no">193</span><span id="line-193"> * Override the default error handler. Default handler simply rethrows the exception.</span>
<span class="source-line-no">194</span><span id="line-194"> */</span>
<span class="source-line-no">195</span><span id="line-195"> public BufferedMutatorParams listener(BufferedMutator.ExceptionListener listener) {</span>
<span class="source-line-no">196</span><span id="line-196"> this.listener = listener;</span>
<span class="source-line-no">197</span><span id="line-197"> return this;</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "CN_IDIOM_NO_SUPER_CALL",</span>
<span class="source-line-no">201</span><span id="line-201"> justification = "The clone below is complete")</span>
<span class="source-line-no">202</span><span id="line-202"> @Override</span>
<span class="source-line-no">203</span><span id="line-203"> public BufferedMutatorParams clone() {</span>
<span class="source-line-no">204</span><span id="line-204"> BufferedMutatorParams clone = new BufferedMutatorParams(this.tableName);</span>
<span class="source-line-no">205</span><span id="line-205"> clone.writeBufferSize = this.writeBufferSize;</span>
<span class="source-line-no">206</span><span id="line-206"> clone.writeBufferPeriodicFlushTimeoutMs = this.writeBufferPeriodicFlushTimeoutMs;</span>
<span class="source-line-no">207</span><span id="line-207"> clone.writeBufferPeriodicFlushTimerTickMs = this.writeBufferPeriodicFlushTimerTickMs;</span>
<span class="source-line-no">208</span><span id="line-208"> clone.maxKeyValueSize = this.maxKeyValueSize;</span>
<span class="source-line-no">209</span><span id="line-209"> clone.pool = this.pool;</span>
<span class="source-line-no">210</span><span id="line-210"> clone.listener = this.listener;</span>
<span class="source-line-no">211</span><span id="line-211"> clone.implementationClassName = this.implementationClassName;</span>
<span class="source-line-no">212</span><span id="line-212"> return clone;</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214">}</span>
</pre>
</div>
</main>
</body>
</html>