| <!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: BalanceResponse, class: Builder"> |
| <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 org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">/**</span> |
| <span class="source-line-no">023</span><span id="line-23"> * Response returned from a balancer invocation</span> |
| <span class="source-line-no">024</span><span id="line-24"> */</span> |
| <span class="source-line-no">025</span><span id="line-25">@InterfaceAudience.Public</span> |
| <span class="source-line-no">026</span><span id="line-26">public final class BalanceResponse {</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28"> /**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Used in HMaster to build a {@link BalanceResponse} for returning results of a balance</span> |
| <span class="source-line-no">030</span><span id="line-30"> * invocation to callers</span> |
| <span class="source-line-no">031</span><span id="line-31"> */</span> |
| <span class="source-line-no">032</span><span id="line-32"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">033</span><span id="line-33"> public final static class Builder {</span> |
| <span class="source-line-no">034</span><span id="line-34"> private boolean balancerRan;</span> |
| <span class="source-line-no">035</span><span id="line-35"> private int movesCalculated;</span> |
| <span class="source-line-no">036</span><span id="line-36"> private int movesExecuted;</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> private Builder() {</span> |
| <span class="source-line-no">039</span><span id="line-39"> }</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 true if the balancer ran, otherwise false. The balancer may not run in some</span> |
| <span class="source-line-no">043</span><span id="line-43"> * circumstances, such as if a balance is already running or there are regions already in</span> |
| <span class="source-line-no">044</span><span id="line-44"> * transition.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * @param balancerRan true if balancer ran, false otherwise</span> |
| <span class="source-line-no">046</span><span id="line-46"> */</span> |
| <span class="source-line-no">047</span><span id="line-47"> public Builder setBalancerRan(boolean balancerRan) {</span> |
| <span class="source-line-no">048</span><span id="line-48"> this.balancerRan = balancerRan;</span> |
| <span class="source-line-no">049</span><span id="line-49"> return this;</span> |
| <span class="source-line-no">050</span><span id="line-50"> }</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"> * Set how many moves were calculated by the balancer. This will be zero if the cluster is</span> |
| <span class="source-line-no">054</span><span id="line-54"> * already balanced.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param movesCalculated moves calculated by the balance run</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 Builder setMovesCalculated(int movesCalculated) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> this.movesCalculated = movesCalculated;</span> |
| <span class="source-line-no">059</span><span id="line-59"> return this;</span> |
| <span class="source-line-no">060</span><span id="line-60"> }</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Set how many of the calculated moves were actually executed by the balancer. This should be</span> |
| <span class="source-line-no">064</span><span id="line-64"> * zero if the balancer is run with {@link BalanceRequest#isDryRun()}. It may also not equal</span> |
| <span class="source-line-no">065</span><span id="line-65"> * movesCalculated if the balancer ran out of time while executing the moves.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param movesExecuted moves executed by the balance run</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> public Builder setMovesExecuted(int movesExecuted) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> this.movesExecuted = movesExecuted;</span> |
| <span class="source-line-no">070</span><span id="line-70"> return this;</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * Build the {@link BalanceResponse}</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public BalanceResponse build() {</span> |
| <span class="source-line-no">077</span><span id="line-77"> return new BalanceResponse(balancerRan, movesCalculated, movesExecuted);</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * Creates a new {@link BalanceResponse.Builder}</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 static Builder newBuilder() {</span> |
| <span class="source-line-no">085</span><span id="line-85"> return new Builder();</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"> private final boolean balancerRan;</span> |
| <span class="source-line-no">089</span><span id="line-89"> private final int movesCalculated;</span> |
| <span class="source-line-no">090</span><span id="line-90"> private final int movesExecuted;</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> private BalanceResponse(boolean balancerRan, int movesCalculated, int movesExecuted) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> this.balancerRan = balancerRan;</span> |
| <span class="source-line-no">094</span><span id="line-94"> this.movesCalculated = movesCalculated;</span> |
| <span class="source-line-no">095</span><span id="line-95"> this.movesExecuted = movesExecuted;</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"> /**</span> |
| <span class="source-line-no">099</span><span id="line-99"> * Returns true if the balancer ran, otherwise false. The balancer may not run for a variety of</span> |
| <span class="source-line-no">100</span><span id="line-100"> * reasons, such as: another balance is running, there are regions in transition, the cluster is</span> |
| <span class="source-line-no">101</span><span id="line-101"> * in maintenance mode, etc.</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> public boolean isBalancerRan() {</span> |
| <span class="source-line-no">104</span><span id="line-104"> return balancerRan;</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"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * The number of moves calculated by the balancer if {@link #isBalancerRan()} is true. This will</span> |
| <span class="source-line-no">109</span><span id="line-109"> * be zero if no better balance could be found.</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111"> public int getMovesCalculated() {</span> |
| <span class="source-line-no">112</span><span id="line-112"> return movesCalculated;</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"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * The number of moves actually executed by the balancer if it ran. This will be zero if</span> |
| <span class="source-line-no">117</span><span id="line-117"> * {@link #getMovesCalculated()} is zero or if {@link BalanceRequest#isDryRun()} was true. It may</span> |
| <span class="source-line-no">118</span><span id="line-118"> * also not be equal to {@link #getMovesCalculated()} if the balancer was interrupted midway</span> |
| <span class="source-line-no">119</span><span id="line-119"> * through executing the moves due to max run time.</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public int getMovesExecuted() {</span> |
| <span class="source-line-no">122</span><span id="line-122"> return movesExecuted;</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
