StartMiniClusterOption (Apache HBase 2.5.0 Test API)

java.lang.Object
- org.apache.hadoop.hbase.StartMiniClusterOption

```
@InterfaceAudience.Public
public final class StartMiniClusterOption
extends Object
```
Options for starting up a mini cluster (including an hbase, dfs and zookeeper clusters) in test. The options include HDFS options to build mini dfs cluster, Zookeeper options to build mini zk cluster, and mostly HBase options to build mini hbase cluster. To create an object, use a StartMiniClusterOption.Builder. Example usage:
```
    StartMiniClusterOption option = StartMiniClusterOption.builder().
        .numMasters(3).rsClass(MyRegionServer.class).createWALDir(true).build();
 
```
Default values can be found in StartMiniClusterOption.Builder.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StartMiniClusterOption.Builder
Builder pattern for creating an StartMiniClusterOption.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StartMiniClusterOption.Builder` Builder pattern for creating an `StartMiniClusterOption`.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`createRootDir` Whether to create a new root or data directory path.
`private boolean`	`createWALDir` Whether to create a new WAL directory.
`private String[]`	`dataNodeHosts` The hostnames of DataNodes to run on.
`private Class<? extends org.apache.hadoop.hbase.master.HMaster>`	`masterClass` The class to use as HMaster, or null for default.
`private int`	`numAlwaysStandByMasters` Number of masters that always remain standby.
`private int`	`numDataNodes` Number of datanodes.
`private int`	`numMasters` Number of masters to start up.
`private int`	`numRegionServers` Number of region servers to start up.
`private int`	`numZkServers` Number of Zookeeper servers.
`private Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer>`	`rsClass` The class to use as HRegionServer, or null for default.
`private List<Integer>`	`rsPorts` Ports that RegionServer should use.

Constructor Summary

Constructors
Modifier	Constructor and Description
`private`	`StartMiniClusterOption(int numMasters, int numAlwaysStandByMasters, Class<? extends org.apache.hadoop.hbase.master.HMaster> masterClass, int numRegionServers, List<Integer> rsPorts, Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> rsClass, int numDataNodes, String[] dataNodeHosts, int numZkServers, boolean createRootDir, boolean createWALDir)` Private constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartMiniClusterOption.Builder`	`builder()` Returns a new builder.
`String[]`	`getDataNodeHosts()`
`Class<? extends org.apache.hadoop.hbase.master.HMaster>`	`getMasterClass()`
`int`	`getNumAlwaysStandByMasters()`
`int`	`getNumDataNodes()`
`int`	`getNumMasters()`
`int`	`getNumRegionServers()`
`int`	`getNumZkServers()`
`Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer>`	`getRsClass()`
`List<Integer>`	`getRsPorts()`
`boolean`	`isCreateRootDir()`
`boolean`	`isCreateWALDir()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - numMasters
```
private final int numMasters
```
    Number of masters to start up. We'll start this many hbase masters. If numMasters > 1, you can find the active/primary master with MiniHBaseCluster.getMaster().
  - numAlwaysStandByMasters
```
private final int numAlwaysStandByMasters
```
    Number of masters that always remain standby. These set of masters never transition to active even if an active master does not exist. These are needed for testing scenarios where there are no active masters in the cluster but the cluster connection (backed by master registry) should still work.
  - masterClass
```
private final Class<? extends org.apache.hadoop.hbase.master.HMaster> masterClass
```
    The class to use as HMaster, or null for default.
  - numRegionServers
```
private final int numRegionServers
```
    Number of region servers to start up. If this value is > 1, then make sure config "hbase.regionserver.info.port" is -1 (i.e. no ui per regionserver) otherwise bind errors.
  - rsPorts
```
private final List<Integer> rsPorts
```
    Ports that RegionServer should use. Pass ports if you want to test cluster restart where for sure the regionservers come up on same address+port (but just with different startcode); by default mini hbase clusters choose new arbitrary ports on each cluster start.
  - rsClass
```
private Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> rsClass
```
    The class to use as HRegionServer, or null for default.
  - numDataNodes
```
private final int numDataNodes
```
    Number of datanodes. Used to create mini DSF cluster. Surpassed by dataNodeHosts size.
  - dataNodeHosts
```
private final String[] dataNodeHosts
```
    The hostnames of DataNodes to run on. This is useful if you want to run datanode on distinct hosts for things like HDFS block location verification. If you start MiniDFSCluster without host names, all instances of the datanodes will have the same host name.
  - numZkServers
```
private final int numZkServers
```
    Number of Zookeeper servers.
  - createRootDir
```
private final boolean createRootDir
```
    Whether to create a new root or data directory path. If true, the newly created data directory will be configured as HBase rootdir. This will overwrite existing root directory config.
  - createWALDir
```
private final boolean createWALDir
```
    Whether to create a new WAL directory. If true, the newly created directory will be configured as HBase wal.dir which is separate from HBase rootdir.
- Constructor Detail
  - StartMiniClusterOption
```
private StartMiniClusterOption(int numMasters,
                               int numAlwaysStandByMasters,
                               Class<? extends org.apache.hadoop.hbase.master.HMaster> masterClass,
                               int numRegionServers,
                               List<Integer> rsPorts,
                               Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> rsClass,
                               int numDataNodes,
                               String[] dataNodeHosts,
                               int numZkServers,
                               boolean createRootDir,
                               boolean createWALDir)
```
    Private constructor. Use StartMiniClusterOption.Builder.build().
- Method Detail
  - getNumMasters
```
public int getNumMasters()
```
  - getNumAlwaysStandByMasters
```
public int getNumAlwaysStandByMasters()
```
  - getMasterClass
```
public Class<? extends org.apache.hadoop.hbase.master.HMaster> getMasterClass()
```
  - getNumRegionServers
```
public int getNumRegionServers()
```
  - getRsPorts
```
public List<Integer> getRsPorts()
```
  - getRsClass
```
public Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> getRsClass()
```
  - getNumDataNodes
```
public int getNumDataNodes()
```
  - getDataNodeHosts
```
public String[] getDataNodeHosts()
```
  - getNumZkServers
```
public int getNumZkServers()
```
  - isCreateRootDir
```
public boolean isCreateRootDir()
```
  - isCreateWALDir
```
public boolean isCreateWALDir()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builder
```
public static StartMiniClusterOption.Builder builder()
```
    Returns a new builder.

Class StartMiniClusterOption

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

numMasters

numAlwaysStandByMasters

masterClass

numRegionServers

rsPorts

rsClass

numDataNodes

dataNodeHosts

numZkServers

createRootDir

createWALDir

Constructor Detail

StartMiniClusterOption

Method Detail

getNumMasters

getNumAlwaysStandByMasters

getMasterClass

getNumRegionServers

getRsPorts

getRsClass

getNumDataNodes

getDataNodeHosts

getNumZkServers

isCreateRootDir

isCreateWALDir

toString

builder