Package org.apache.hadoop.hbase.client

Class BalanceResponse

java.lang.Object

org.apache.hadoop.hbase.client.BalanceResponse

@Public
public final class BalanceResponse
extends Object

Response returned from a balancer invocation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BalanceResponse.Builder	Used in HMaster to build a BalanceResponse for returning results of a balance invocation to callers

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	balancerRan
private final int	movesCalculated
private final int	movesExecuted

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BalanceResponse(boolean balancerRan, int movesCalculated, int movesExecuted)

Method Summary

Modifier and Type	Method	Description
int	getMovesCalculated()	The number of moves calculated by the balancer if isBalancerRan() is true.
int	getMovesExecuted()	The number of moves actually executed by the balancer if it ran.
boolean	isBalancerRan()	Returns true if the balancer ran, otherwise false.
static BalanceResponse.Builder	newBuilder()	Creates a new BalanceResponse.Builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

balancerRan

private final boolean balancerRan

movesCalculated

private final int movesCalculated

movesExecuted

private final int movesExecuted

Constructor Details

BalanceResponse

private BalanceResponse(boolean balancerRan,
 int movesCalculated,
 int movesExecuted)

Method Details

newBuilder

public static BalanceResponse.Builder newBuilder()

Creates a new BalanceResponse.Builder

isBalancerRan

public boolean isBalancerRan()

Returns true if the balancer ran, otherwise false. The balancer may not run for a variety of reasons, such as: another balance is running, there are regions in transition, the cluster is in maintenance mode, etc.

getMovesCalculated

public int getMovesCalculated()

The number of moves calculated by the balancer if isBalancerRan() is true. This will be zero if no better balance could be found.

getMovesExecuted

public int getMovesExecuted()

The number of moves actually executed by the balancer if it ran. This will be zero if getMovesCalculated() is zero or if BalanceRequest.isDryRun() was true. It may also not be equal to getMovesCalculated() if the balancer was interrupted midway through executing the moves due to max run time.