Package org.apache.hadoop.hbase.client

Class BalanceRequest

java.lang.Object

org.apache.hadoop.hbase.client.BalanceRequest

@Public
public final class BalanceRequest
extends Object

Encapsulates options for executing a run of the Balancer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BalanceRequest.Builder	Builder for constructing a BalanceRequest

Field Summary

Fields

Modifier and Type	Field	Description
private static final BalanceRequest	DEFAULT
private final boolean	dryRun
private final boolean	ignoreRegionsInTransition

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BalanceRequest(boolean dryRun, boolean ignoreRegionsInTransition)

Method Summary

Modifier and Type	Method	Description
static BalanceRequest	defaultInstance()	Get a BalanceRequest for a default run of the balancer.
boolean	isDryRun()	Returns true if the balancer should run in dry run mode, otherwise false.
boolean	isIgnoreRegionsInTransition()	Returns true if the balancer should execute even if regions are in transition, otherwise false.
static BalanceRequest.Builder	newBuilder()	Create a builder to construct a custom BalanceRequest.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

private static final BalanceRequest DEFAULT

dryRun

private final boolean dryRun

ignoreRegionsInTransition

private final boolean ignoreRegionsInTransition

Constructor Details

BalanceRequest

private BalanceRequest(boolean dryRun,
 boolean ignoreRegionsInTransition)

Method Details

newBuilder

public static BalanceRequest.Builder newBuilder()

Create a builder to construct a custom BalanceRequest.

defaultInstance

public static BalanceRequest defaultInstance()

Get a BalanceRequest for a default run of the balancer. The default mode executes any moves calculated and will not run if regions are already in transition.

isDryRun

public boolean isDryRun()

Returns true if the balancer should run in dry run mode, otherwise false. In dry run mode, moves will be calculated but not executed.

isIgnoreRegionsInTransition

public boolean isIgnoreRegionsInTransition()

Returns true if the balancer should execute even if regions are in transition, otherwise false. This is an advanced usage feature, as it can cause more issues than it fixes.