| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * Encapsulates options for executing a run of the Balancer.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> */<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>@InterfaceAudience.Public<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>public final class BalanceRequest {<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> private static final BalanceRequest DEFAULT = BalanceRequest.newBuilder().build();<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> /**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Builder for constructing a {@link BalanceRequest}<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> */<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> @InterfaceAudience.Public<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> public final static class Builder {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> private boolean dryRun = false;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> private boolean ignoreRegionsInTransition = false;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private Builder() {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> }<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Updates BalancerRequest to run the balancer in dryRun mode. In this mode, the balancer will<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * try to find a plan but WILL NOT execute any region moves or call any coprocessors. You can<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * run in dryRun mode regardless of whether the balancer switch is enabled or disabled, but<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * dryRun mode will not run over an existing request or chore. Dry run is useful for testing out<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * new balance configs. See the logs on the active HMaster for the results of the dry run.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public Builder setDryRun(boolean dryRun) {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> this.dryRun = dryRun;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> return this;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> }<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Updates BalancerRequest to run the balancer even if there are regions in transition. WARNING:<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Advanced usage only, this could cause more issues than it fixes.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public Builder setIgnoreRegionsInTransition(boolean ignoreRegionsInTransition) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> this.ignoreRegionsInTransition = ignoreRegionsInTransition;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> return this;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> }<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Build the {@link BalanceRequest}<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public BalanceRequest build() {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> return new BalanceRequest(dryRun, ignoreRegionsInTransition);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Create a builder to construct a custom {@link BalanceRequest}.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public static Builder newBuilder() {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return new Builder();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Get a BalanceRequest for a default run of the balancer. The default mode executes any moves<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * calculated and will not run if regions are already in transition.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> public static BalanceRequest defaultInstance() {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return DEFAULT;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private final boolean dryRun;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private final boolean ignoreRegionsInTransition;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> private BalanceRequest(boolean dryRun, boolean ignoreRegionsInTransition) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.dryRun = dryRun;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this.ignoreRegionsInTransition = ignoreRegionsInTransition;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Returns true if the balancer should run in dry run mode, otherwise false. In dry run mode,<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * moves will be calculated but not executed.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public boolean isDryRun() {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> return dryRun;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Returns true if the balancer should execute even if regions are in transition, otherwise false.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * This is an advanced usage feature, as it can cause more issues than it fixes.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public boolean isIgnoreRegionsInTransition() {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return ignoreRegionsInTransition;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span>}<a name="line.107"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
