AsyncHBaseAdmin (Apache HBase - Client 2.0.0-alpha4 API)

java.lang.Object
- org.apache.hadoop.hbase.client.AsyncHBaseAdmin

All Implemented Interfaces:: AsyncAdmin

@InterfaceAudience.Private
public class AsyncHBaseAdmin
extends Object
implements AsyncAdmin

The implementation of AsyncAdmin.

Since:: 2.0.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompletableFuture<Boolean>`	`abortProcedure(long procId, boolean mayInterruptIfRunning)` abort a procedure
`CompletableFuture<Void>`	`addColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)` Add a column family to an existing table.
`CompletableFuture<Void>`	`addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig)` Add a new replication peer for replicating data to slave cluster
`CompletableFuture<Void>`	`appendReplicationPeerTableCFs(String peerId, Map<TableName,? extends Collection<String>> tableCfs)` Append the replicable table-cf config of the specified peer
`CompletableFuture<Void>`	`assign(byte[] regionName)`
`CompletableFuture<Boolean>`	`balance(boolean forcible)` Invoke the balancer.
`CompletableFuture<Void>`	`clearCompactionQueues(ServerName serverName, Set<String> queues)` Clear compacting queues on a region server.
`CompletableFuture<List<ServerName>>`	`clearDeadServers(List<ServerName> servers)` Clear dead region servers from master.
`CompletableFuture<Void>`	`cloneSnapshot(String snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`CompletableFuture<Void>`	`compact(TableName tableName, Optional<byte[]> columnFamily)` Compact a column family within a table.
`CompletableFuture<Void>`	`compactRegion(byte[] regionName, Optional<byte[]> columnFamily)` Compact a column family within a region.
`CompletableFuture<Void>`	`compactRegionServer(ServerName serverName)` Compact all regions on the region server.
`<S,R> CompletableFuture<R>`	`coprocessorService(Function<com.google.protobuf.RpcChannel,S> stubMaker, RawAsyncTable.CoprocessorCallable<S,R> callable)` Execute the given coprocessor call on the master.
`<S,R> CompletableFuture<R>`	`coprocessorService(Function<com.google.protobuf.RpcChannel,S> stubMaker, RawAsyncTable.CoprocessorCallable<S,R> callable, ServerName serverName)` Execute the given coprocessor call on the given region server.
`CompletableFuture<Void>`	`createNamespace(NamespaceDescriptor descriptor)` Create a new namespace.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)` Creates a new table with the specified number of regions.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, Optional<byte[][]> splitKeys)` Creates a new table with an initial set of empty regions defined by the specified split keys.
`CompletableFuture<Void>`	`decommissionRegionServers(List<ServerName> servers, boolean offload)` Mark region server(s) as decommissioned to prevent additional regions from getting assigned to them.
`CompletableFuture<Void>`	`deleteColumnFamily(TableName tableName, byte[] columnFamily)` Delete a column family from a table.
`CompletableFuture<Void>`	`deleteNamespace(String name)` Delete an existing namespace.
`CompletableFuture<Void>`	`deleteSnapshot(String snapshotName)` Delete an existing snapshot.
`CompletableFuture<Void>`	`deleteTable(TableName tableName)` Deletes a table.
`CompletableFuture<Void>`	`deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`disableReplicationPeer(String peerId)` Stop the replication stream to the specified peer
`CompletableFuture<Void>`	`disableTable(TableName tableName)` Disable a table.
`CompletableFuture<Void>`	`enableReplicationPeer(String peerId)` Restart the replication stream to the specified peer
`CompletableFuture<Void>`	`enableTable(TableName tableName)` Enable a table.
`CompletableFuture<Void>`	`execProcedure(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`CompletableFuture<byte[]>`	`execProcedureWithRet(String signature, String instance, Map<String,String> props)` Execute a distributed procedure on a cluster.
`CompletableFuture<Void>`	`flush(TableName tableName)` Flush a table.
`CompletableFuture<Void>`	`flushRegion(byte[] regionName)` Flush an individual region.
`CompletableFuture<ClusterStatus>`	`getClusterStatus()`
`CompletableFuture<ClusterStatus>`	`getClusterStatus(EnumSet<ClusterStatus.Option> options)`
`CompletableFuture<CompactionState>`	`getCompactionState(TableName tableName)` Get the current compaction state of a table.
`CompletableFuture<CompactionState>`	`getCompactionStateForRegion(byte[] regionName)` Get the current compaction state of region.
`CompletableFuture<Optional<Long>>`	`getLastMajorCompactionTimestamp(TableName tableName)` Get the timestamp of the last major compaction for the passed table.
`CompletableFuture<Optional<Long>>`	`getLastMajorCompactionTimestampForRegion(byte[] regionName)` Get the timestamp of the last major compaction for the passed region.
`CompletableFuture<String>`	`getLocks()` List locks.
`CompletableFuture<NamespaceDescriptor>`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name
`CompletableFuture<List<RegionInfo>>`	`getOnlineRegions(ServerName serverName)` Get all the online regions on a region server.
`CompletableFuture<String>`	`getProcedures()` List procedures
`CompletableFuture<List<QuotaSettings>>`	`getQuota(QuotaFilter filter)` List the quotas based on the filter.
`CompletableFuture<List<RegionLoad>>`	`getRegionLoads(ServerName serverName, Optional<TableName> tableName)` Get a list of `RegionLoad` of all regions hosted on a region seerver for a table.
`CompletableFuture<ReplicationPeerConfig>`	`getReplicationPeerConfig(String peerId)` Returns the configured ReplicationPeerConfig for the specified peer
`CompletableFuture<List<SecurityCapability>>`	`getSecurityCapabilities()`
`CompletableFuture<TableDescriptor>`	`getTableDescriptor(TableName tableName)` Method for getting the tableDescriptor
`CompletableFuture<List<RegionInfo>>`	`getTableRegions(TableName tableName)` Get the regions of a given table.
`CompletableFuture<Boolean>`	`isBalancerOn()` Query the current state of the balancer.
`CompletableFuture<Boolean>`	`isCatalogJanitorOn()` Query on the catalog janitor state.
`CompletableFuture<Boolean>`	`isCleanerChoreOn()` Query the current state of the cleaner chore.
`CompletableFuture<Boolean>`	`isMasterInMaintenanceMode()` Check whether master is in maintenance mode
`CompletableFuture<Boolean>`	`isMergeOn()` Query the current state of the Merge switch.
`CompletableFuture<Boolean>`	`isNormalizerOn()` Query the current state of the region normalizer
`CompletableFuture<Boolean>`	`isProcedureFinished(String signature, String instance, Map<String,String> props)` Check the current state of the specified procedure.
`CompletableFuture<Boolean>`	`isSnapshotFinished(SnapshotDescription snapshot)` Check the current state of the passed snapshot.
`CompletableFuture<Boolean>`	`isSplitOn()` Query the current state of the Split switch.
`CompletableFuture<Boolean>`	`isTableAvailable(TableName tableName, byte[][] splitKeys)` Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table.
`CompletableFuture<Boolean>`	`isTableDisabled(TableName tableName)`
`CompletableFuture<Boolean>`	`isTableEnabled(TableName tableName)`
`CompletableFuture<List<ServerName>>`	`listDeadServers()` List all the dead region servers.
`CompletableFuture<List<ServerName>>`	`listDecommissionedRegionServers()` List region servers marked as decommissioned, which can not be assigned regions.
`CompletableFuture<List<NamespaceDescriptor>>`	`listNamespaceDescriptors()` List available namespace descriptors
`CompletableFuture<List<TableCFs>>`	`listReplicatedTableCFs()` Find all table and column families that are replicated from this cluster
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers(Optional<Pattern> pattern)` Return a list of replication peers.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots(Optional<Pattern> pattern)` List all the completed snapshots matching the given pattern.
`CompletableFuture<List<TableName>>`	`listTableNames(Optional<Pattern> pattern, boolean includeSysTables)` List all of the names of userspace tables.
`CompletableFuture<List<TableDescriptor>>`	`listTables(Optional<Pattern> pattern, boolean includeSysTables)` List all the tables matching the given pattern.
`CompletableFuture<List<SnapshotDescription>>`	`listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`majorCompact(TableName tableName, Optional<byte[]> columnFamily)` Major compact a column family within a table.
`CompletableFuture<Void>`	`majorCompactRegion(byte[] regionName, Optional<byte[]> columnFamily)` Major compact a column family within region.
`CompletableFuture<Void>`	`majorCompactRegionServer(ServerName serverName)` Compact all regions on the region server.
`CompletableFuture<Void>`	`mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`CompletableFuture<Void>`	`modifyColumnFamily(TableName tableName, ColumnFamilyDescriptor columnFamily)` Modify an existing column family on a table.
`CompletableFuture<Void>`	`modifyNamespace(NamespaceDescriptor descriptor)` Modify an existing namespace.
`CompletableFuture<Void>`	`move(byte[] regionName, Optional<ServerName> destServerName)` Move the region `r` to `dest`.
`CompletableFuture<Boolean>`	`normalize()` Invoke region normalizer.
`CompletableFuture<Void>`	`offline(byte[] regionName)` Offline specified region from master's in-memory state.
`CompletableFuture<Void>`	`recommissionRegionServer(ServerName server, List<byte[]> encodedRegionNames)` Remove decommission marker from a region server to allow regions assignments.
`CompletableFuture<Void>`	`removeReplicationPeer(String peerId)` Remove a peer and stop the replication
`CompletableFuture<Void>`	`removeReplicationPeerTableCFs(String peerId, Map<TableName,? extends Collection<String>> tableCfs)` Remove some table-cfs from config of the specified peer
`CompletableFuture<Void>`	`restoreSnapshot(String snapshotName)` Restore the specified snapshot on the original table.
`CompletableFuture<Void>`	`restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot)` Restore the specified snapshot on the original table.
`CompletableFuture<Void>`	`rollWALWriter(ServerName serverName)` Roll the log writer.
`CompletableFuture<Integer>`	`runCatalogJanitor()` Ask for a scan of the catalog table.
`CompletableFuture<Boolean>`	`runCleanerChore()` Ask for cleaner chore to run.
`CompletableFuture<Boolean>`	`setBalancerOn(boolean on)` Turn the load balancer on or off.
`CompletableFuture<Boolean>`	`setCatalogJanitorOn(boolean enabled)` Turn the catalog janitor on/off.
`CompletableFuture<Boolean>`	`setCleanerChoreOn(boolean enabled)` Turn the cleaner chore on/off.
`CompletableFuture<Boolean>`	`setMergeOn(boolean on)` Turn the Merge switch on or off.
`CompletableFuture<Boolean>`	`setNormalizerOn(boolean on)` Set region normalizer on/off.
`CompletableFuture<Void>`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`CompletableFuture<Boolean>`	`setSplitOn(boolean on)` Turn the Split switch on or off.
`CompletableFuture<Void>`	`shutdown()` Shuts down the HBase cluster.
`CompletableFuture<Void>`	`snapshot(SnapshotDescription snapshot)` Take a snapshot and wait for the server to complete that snapshot asynchronously.
`CompletableFuture<Void>`	`split(TableName tableName)` Split a table.
`CompletableFuture<Void>`	`split(TableName tableName, byte[] splitPoint)` Split a table.
`CompletableFuture<Void>`	`splitRegion(byte[] regionName, Optional<byte[]> splitPoint)` Split an individual region.
`CompletableFuture<Void>`	`stopMaster()` Shuts down the current HBase master only.
`CompletableFuture<Void>`	`stopRegionServer(ServerName serverName)` Stop the designated regionserver.
`CompletableFuture<Boolean>`	`tableExists(TableName tableName)`
`CompletableFuture<Void>`	`truncateTable(TableName tableName, boolean preserveSplits)` Truncate a table.
`CompletableFuture<Void>`	`unassign(byte[] regionName, boolean forcible)` Unassign a region from current hosting regionserver.
`CompletableFuture<Void>`	`updateConfiguration()` Update the configuration and trigger an online config change on all the masters and regionservers.
`CompletableFuture<Void>`	`updateConfiguration(ServerName serverName)` Update the configuration and trigger an online config change on the regionserver.
`CompletableFuture<Void>`	`updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig)` Update the peerConfig for the specified peer

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

Methods inherited from interface org.apache.hadoop.hbase.client.AsyncAdmin
balance, compact, compactRegion, createTable, deleteSnapshots, getBackupMasters, getMaster, getMasterInfoPort, getRegionLoads, getRegionServers, isTableAvailable, listReplicationPeers, listSnapshots, listTableNames, listTables, majorCompact, majorCompactRegion, snapshot, snapshot, splitRegion

- Method Detail
  - tableExists
```
public CompletableFuture<Boolean> tableExists(TableName tableName)
```
    Specified by:
    
    tableExists in interface AsyncAdmin
    
    Parameters:
    
    tableName - Table to check.
    
    Returns:
    
    True if table exists already. The return value will be wrapped by a CompletableFuture.
  - listTables
```
public CompletableFuture<List<TableDescriptor>> listTables(Optional<Pattern> pattern,
                                                           boolean includeSysTables)
```
    Description copied from interface: AsyncAdmin
    
    List all the tables matching the given pattern.
    
    Specified by:
    
    listTables in interface AsyncAdmin
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    - returns a list of TableDescriptors wrapped by a CompletableFuture.
  - listTableNames
```
public CompletableFuture<List<TableName>> listTableNames(Optional<Pattern> pattern,
                                                         boolean includeSysTables)
```
    Description copied from interface: AsyncAdmin
    
    List all of the names of userspace tables.
    
    Specified by:
    
    listTableNames in interface AsyncAdmin
    
    Parameters:
    
    pattern - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    a list of table names wrapped by a CompletableFuture.
  - getTableDescriptor
```
public CompletableFuture<TableDescriptor> getTableDescriptor(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Method for getting the tableDescriptor
    
    Specified by:
    
    getTableDescriptor in interface AsyncAdmin
    
    Parameters:
    
    tableName - as a TableName
    
    Returns:
    
    the read-only tableDescriptor wrapped by a CompletableFuture.
  - createTable
```
public CompletableFuture<Void> createTable(TableDescriptor desc,
                                           byte[] startKey,
                                           byte[] endKey,
                                           int numRegions)
```
    Description copied from interface: AsyncAdmin
    
    Creates a new table with the specified number of regions. The start key specified will become the end key of the first region of the table, and the end key specified will become the start key of the last region of the table (the first region has a null start key and the last region has a null end key). BigInteger math will be used to divide the key range specified into enough segments to make the required number of total regions.
    
    Specified by:
    
    createTable in interface AsyncAdmin
    
    Parameters:
    
    desc - table descriptor for table
    
    startKey - beginning of key range
    
    endKey - end of key range
    
    numRegions - the total number of regions to create
  - createTable
```
public CompletableFuture<Void> createTable(TableDescriptor desc,
                                           Optional<byte[][]> splitKeys)
```
    Description copied from interface: AsyncAdmin
    
    Creates a new table with an initial set of empty regions defined by the specified split keys. The total number of regions created will be the number of split keys plus one. Note : Avoid passing empty split key.
    
    Specified by:
    
    createTable in interface AsyncAdmin
    
    Parameters:
    
    desc - table descriptor for table
    
    splitKeys - array of split keys for the initial regions of the table
  - deleteTable
```
public CompletableFuture<Void> deleteTable(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Deletes a table.
    
    Specified by:
    
    deleteTable in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to delete
  - truncateTable
```
public CompletableFuture<Void> truncateTable(TableName tableName,
                                             boolean preserveSplits)
```
    Description copied from interface: AsyncAdmin
    
    Truncate a table.
    
    Specified by:
    
    truncateTable in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to truncate
    
    preserveSplits - True if the splits should be preserved
  - enableTable
```
public CompletableFuture<Void> enableTable(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Enable a table. The table has to be in disabled state for it to be enabled.
    
    Specified by:
    
    enableTable in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of the table
  - disableTable
```
public CompletableFuture<Void> disableTable(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Disable a table. The table has to be in enabled state for it to be disabled.
    
    Specified by:
    
    disableTable in interface AsyncAdmin
  - isTableEnabled
```
public CompletableFuture<Boolean> isTableEnabled(TableName tableName)
```
    Specified by:
    
    isTableEnabled in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is on-line. The return value will be wrapped by a CompletableFuture.
  - isTableDisabled
```
public CompletableFuture<Boolean> isTableDisabled(TableName tableName)
```
    Specified by:
    
    isTableDisabled in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if table is off-line. The return value will be wrapped by a CompletableFuture.
  - isTableAvailable
```
public CompletableFuture<Boolean> isTableAvailable(TableName tableName,
                                                   byte[][] splitKeys)
```
    Description copied from interface: AsyncAdmin
    
    Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table. Note : If this api is used after a table's region gets splitted, the api may return false. The return value will be wrapped by a CompletableFuture.
    
    Specified by:
    
    isTableAvailable in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to check
    
    splitKeys - keys to check if the table has been created with all split keys
  - addColumnFamily
```
public CompletableFuture<Void> addColumnFamily(TableName tableName,
                                               ColumnFamilyDescriptor columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Add a column family to an existing table.
    
    Specified by:
    
    addColumnFamily in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of the table to add column family to
    
    columnFamily - column family descriptor of column family to be added
  - deleteColumnFamily
```
public CompletableFuture<Void> deleteColumnFamily(TableName tableName,
                                                  byte[] columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Delete a column family from a table.
    
    Specified by:
    
    deleteColumnFamily in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - name of column family to be deleted
  - modifyColumnFamily
```
public CompletableFuture<Void> modifyColumnFamily(TableName tableName,
                                                  ColumnFamilyDescriptor columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Modify an existing column family on a table.
    
    Specified by:
    
    modifyColumnFamily in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table
    
    columnFamily - new column family descriptor to use
  - createNamespace
```
public CompletableFuture<Void> createNamespace(NamespaceDescriptor descriptor)
```
    Description copied from interface: AsyncAdmin
    
    Create a new namespace.
    
    Specified by:
    
    createNamespace in interface AsyncAdmin
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
  - modifyNamespace
```
public CompletableFuture<Void> modifyNamespace(NamespaceDescriptor descriptor)
```
    Description copied from interface: AsyncAdmin
    
    Modify an existing namespace.
    
    Specified by:
    
    modifyNamespace in interface AsyncAdmin
    
    Parameters:
    
    descriptor - descriptor which describes the new namespace
  - deleteNamespace
```
public CompletableFuture<Void> deleteNamespace(String name)
```
    Description copied from interface: AsyncAdmin
    
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    Specified by:
    
    deleteNamespace in interface AsyncAdmin
    
    Parameters:
    
    name - namespace name
  - getNamespaceDescriptor
```
public CompletableFuture<NamespaceDescriptor> getNamespaceDescriptor(String name)
```
    Description copied from interface: AsyncAdmin
    
    Get a namespace descriptor by name
    
    Specified by:
    
    getNamespaceDescriptor in interface AsyncAdmin
    
    Parameters:
    
    name - name of namespace descriptor
    
    Returns:
    
    A descriptor wrapped by a CompletableFuture.
  - listNamespaceDescriptors
```
public CompletableFuture<List<NamespaceDescriptor>> listNamespaceDescriptors()
```
    Description copied from interface: AsyncAdmin
    
    List available namespace descriptors
    
    Specified by:
    
    listNamespaceDescriptors in interface AsyncAdmin
    
    Returns:
    
    List of descriptors wrapped by a CompletableFuture.
  - getOnlineRegions
```
public CompletableFuture<List<RegionInfo>> getOnlineRegions(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Get all the online regions on a region server.
    
    Specified by:
    
    getOnlineRegions in interface AsyncAdmin
  - getTableRegions
```
public CompletableFuture<List<RegionInfo>> getTableRegions(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Get the regions of a given table.
    
    Specified by:
    
    getTableRegions in interface AsyncAdmin
  - flush
```
public CompletableFuture<Void> flush(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Flush a table.
    
    Specified by:
    
    flush in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to flush
  - flushRegion
```
public CompletableFuture<Void> flushRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Flush an individual region.
    
    Specified by:
    
    flushRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to flush
  - compact
```
public CompletableFuture<Void> compact(TableName tableName,
                                       Optional<byte[]> columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Compact a column family within a table. When the returned CompletableFuture is done, it only means the compact request was sent to HBase and may need some time to finish the compact operation.
    
    Specified by:
    
    compact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table. If not present, compact the table's all column families.
  - compactRegion
```
public CompletableFuture<Void> compactRegion(byte[] regionName,
                                             Optional<byte[]> columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Compact a column family within a region. When the returned CompletableFuture is done, it only means the compact request was sent to HBase and may need some time to finish the compact operation.
    
    Specified by:
    
    compactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to compact
    
    columnFamily - column family within a region. If not present, compact the region's all column families.
  - majorCompact
```
public CompletableFuture<Void> majorCompact(TableName tableName,
                                            Optional<byte[]> columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a column family within a table. When the returned CompletableFuture is done, it only means the compact request was sent to HBase and may need some time to finish the compact operation.
    
    Specified by:
    
    majorCompact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to major compact
    
    columnFamily - column family within a table. If not present, major compact the table's all column families.
  - majorCompactRegion
```
public CompletableFuture<Void> majorCompactRegion(byte[] regionName,
                                                  Optional<byte[]> columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a column family within region. When the returned CompletableFuture is done, it only means the compact request was sent to HBase and may need some time to finish the compact operation.
    
    Specified by:
    
    majorCompactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to major compact
    
    columnFamily - column family within a region. If not present, major compact the region's all column families.
  - compactRegionServer
```
public CompletableFuture<Void> compactRegionServer(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Compact all regions on the region server.
    
    Specified by:
    
    compactRegionServer in interface AsyncAdmin
    
    Parameters:
    
    serverName - the region server name
  - majorCompactRegionServer
```
public CompletableFuture<Void> majorCompactRegionServer(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Compact all regions on the region server.
    
    Specified by:
    
    majorCompactRegionServer in interface AsyncAdmin
    
    Parameters:
    
    serverName - the region server name
  - setMergeOn
```
public CompletableFuture<Boolean> setMergeOn(boolean on)
```
    Description copied from interface: AsyncAdmin
    
    Turn the Merge switch on or off.
    
    Specified by:
    
    setMergeOn in interface AsyncAdmin
    
    Returns:
    
    Previous switch value wrapped by a CompletableFuture
  - isMergeOn
```
public CompletableFuture<Boolean> isMergeOn()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the Merge switch.
    
    Specified by:
    
    isMergeOn in interface AsyncAdmin
    
    Returns:
    
    true if the switch is on, false otherwise. The return value will be wrapped by a CompletableFuture
  - setSplitOn
```
public CompletableFuture<Boolean> setSplitOn(boolean on)
```
    Description copied from interface: AsyncAdmin
    
    Turn the Split switch on or off.
    
    Specified by:
    
    setSplitOn in interface AsyncAdmin
    
    Returns:
    
    Previous switch value wrapped by a CompletableFuture
  - isSplitOn
```
public CompletableFuture<Boolean> isSplitOn()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the Split switch.
    
    Specified by:
    
    isSplitOn in interface AsyncAdmin
    
    Returns:
    
    true if the switch is on, false otherwise. The return value will be wrapped by a CompletableFuture
  - mergeRegions
```
public CompletableFuture<Void> mergeRegions(byte[] nameOfRegionA,
                                            byte[] nameOfRegionB,
                                            boolean forcible)
```
    Description copied from interface: AsyncAdmin
    
    Merge two regions.
    
    Specified by:
    
    mergeRegions in interface AsyncAdmin
    
    Parameters:
    
    nameOfRegionA - encoded or full name of region a
    
    nameOfRegionB - encoded or full name of region b
    
    forcible - true if do a compulsory merge, otherwise we will only merge two adjacent regions
  - split
```
public CompletableFuture<Void> split(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Split a table. The method will execute split action for each region in table.
    
    Specified by:
    
    split in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to split
  - split
```
public CompletableFuture<Void> split(TableName tableName,
                                     byte[] splitPoint)
```
    Description copied from interface: AsyncAdmin
    
    Split a table.
    
    Specified by:
    
    split in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to split
    
    splitPoint - the explicit position to split on
  - splitRegion
```
public CompletableFuture<Void> splitRegion(byte[] regionName,
                                           Optional<byte[]> splitPoint)
```
    Description copied from interface: AsyncAdmin
    
    Split an individual region.
    
    Specified by:
    
    splitRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to split
    
    splitPoint - the explicit position to split on. If not present, it will decide by region server.
  - assign
```
public CompletableFuture<Void> assign(byte[] regionName)
```
    Specified by:
    
    assign in interface AsyncAdmin
    
    Parameters:
    
    regionName - Encoded or full name of region to assign.
  - unassign
```
public CompletableFuture<Void> unassign(byte[] regionName,
                                        boolean forcible)
```
    Description copied from interface: AsyncAdmin
    
    Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use AsyncAdmin.move(byte[], Optional) if you want to control the region movement.
    
    Specified by:
    
    unassign in interface AsyncAdmin
    
    Parameters:
    
    regionName - Encoded or full name of region to unassign. Will clear any existing RegionPlan if one found.
    
    forcible - If true, force unassign (Will remove region from regions-in-transition too if present. If results in double assignment use hbck -fix to resolve. To be used by experts).
  - offline
```
public CompletableFuture<Void> offline(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Offline specified region from master's in-memory state. It will not attempt to reassign the region as in unassign. This API can be used when a region not served by any region server and still online as per Master's in memory state. If this API is incorrectly used on active region then master will loose track of that region. This is a special method that should be used by experts or hbck.
    
    Specified by:
    
    offline in interface AsyncAdmin
    
    Parameters:
    
    regionName - Encoded or full name of region to offline
  - move
```
public CompletableFuture<Void> move(byte[] regionName,
                                    Optional<ServerName> destServerName)
```
    Description copied from interface: AsyncAdmin
    
    Move the region r to dest.
    
    Specified by:
    
    move in interface AsyncAdmin
    
    Parameters:
    
    regionName - Encoded or full name of region to move.
    
    destServerName - The servername of the destination regionserver. If not present, we'll assign to a random server. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
  - setQuota
```
public CompletableFuture<Void> setQuota(QuotaSettings quota)
```
    Description copied from interface: AsyncAdmin
    
    Apply the new quota settings.
    
    Specified by:
    
    setQuota in interface AsyncAdmin
    
    Parameters:
    
    quota - the quota settings
  - getQuota
```
public CompletableFuture<List<QuotaSettings>> getQuota(QuotaFilter filter)
```
    Description copied from interface: AsyncAdmin
    
    List the quotas based on the filter.
    
    Specified by:
    
    getQuota in interface AsyncAdmin
    
    Parameters:
    
    filter - the quota settings filter
    
    Returns:
    
    the QuotaSetting list, which wrapped by a CompletableFuture.
  - addReplicationPeer
```
public CompletableFuture<Void> addReplicationPeer(String peerId,
                                                  ReplicationPeerConfig peerConfig)
```
    Description copied from interface: AsyncAdmin
    
    Add a new replication peer for replicating data to slave cluster
    
    Specified by:
    
    addReplicationPeer in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - configuration for the replication slave cluster
  - removeReplicationPeer
```
public CompletableFuture<Void> removeReplicationPeer(String peerId)
```
    Description copied from interface: AsyncAdmin
    
    Remove a peer and stop the replication
    
    Specified by:
    
    removeReplicationPeer in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - enableReplicationPeer
```
public CompletableFuture<Void> enableReplicationPeer(String peerId)
```
    Description copied from interface: AsyncAdmin
    
    Restart the replication stream to the specified peer
    
    Specified by:
    
    enableReplicationPeer in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - disableReplicationPeer
```
public CompletableFuture<Void> disableReplicationPeer(String peerId)
```
    Description copied from interface: AsyncAdmin
    
    Stop the replication stream to the specified peer
    
    Specified by:
    
    disableReplicationPeer in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
  - getReplicationPeerConfig
```
public CompletableFuture<ReplicationPeerConfig> getReplicationPeerConfig(String peerId)
```
    Description copied from interface: AsyncAdmin
    
    Returns the configured ReplicationPeerConfig for the specified peer
    
    Specified by:
    
    getReplicationPeerConfig in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    Returns:
    
    ReplicationPeerConfig for the peer wrapped by a CompletableFuture.
  - updateReplicationPeerConfig
```
public CompletableFuture<Void> updateReplicationPeerConfig(String peerId,
                                                           ReplicationPeerConfig peerConfig)
```
    Description copied from interface: AsyncAdmin
    
    Update the peerConfig for the specified peer
    
    Specified by:
    
    updateReplicationPeerConfig in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the peer
    
    peerConfig - new config for the peer
  - appendReplicationPeerTableCFs
```
public CompletableFuture<Void> appendReplicationPeerTableCFs(String peerId,
                                                             Map<TableName,? extends Collection<String>> tableCfs)
```
    Description copied from interface: AsyncAdmin
    
    Append the replicable table-cf config of the specified peer
    
    Specified by:
    
    appendReplicationPeerTableCFs in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - removeReplicationPeerTableCFs
```
public CompletableFuture<Void> removeReplicationPeerTableCFs(String peerId,
                                                             Map<TableName,? extends Collection<String>> tableCfs)
```
    Description copied from interface: AsyncAdmin
    
    Remove some table-cfs from config of the specified peer
    
    Specified by:
    
    removeReplicationPeerTableCFs in interface AsyncAdmin
    
    Parameters:
    
    peerId - a short name that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - listReplicationPeers
```
public CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(Optional<Pattern> pattern)
```
    Description copied from interface: AsyncAdmin
    
    Return a list of replication peers.
    
    Specified by:
    
    listReplicationPeers in interface AsyncAdmin
    
    Parameters:
    
    pattern - The compiled regular expression to match peer id
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicatedTableCFs
```
public CompletableFuture<List<TableCFs>> listReplicatedTableCFs()
```
    Description copied from interface: AsyncAdmin
    
    Find all table and column families that are replicated from this cluster
    
    Specified by:
    
    listReplicatedTableCFs in interface AsyncAdmin
    
    Returns:
    
    the replicated table-cfs list of this cluster. The return value will be wrapped by a CompletableFuture.
  - snapshot
```
public CompletableFuture<Void> snapshot(SnapshotDescription snapshot)
```
    Description copied from interface: AsyncAdmin
    
    Take a snapshot and wait for the server to complete that snapshot asynchronously. Only a single snapshot should be taken at a time for an instance of HBase, or results may be undefined (you can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a single cluster). Snapshots are considered unique based on the name of the snapshot. Attempts to take a snapshot with the same name (even a different type or with different parameters) will fail with a SnapshotCreationException indicating the duplicate naming. Snapshot names follow the same naming constraints as tables in HBase. See TableName.isLegalFullyQualifiedTableName(byte[]). You should probably use AsyncAdmin.snapshot(String, org.apache.hadoop.hbase.TableName) unless you are sure about the type of snapshot that you want to take.
    
    Specified by:
    
    snapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshot - snapshot to take
  - isSnapshotFinished
```
public CompletableFuture<Boolean> isSnapshotFinished(SnapshotDescription snapshot)
```
    Description copied from interface: AsyncAdmin
    Check the current state of the passed snapshot. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the snapshot to fail
    The cluster only knows about the most recent snapshot. Therefore, if another snapshot has been run/started since the snapshot you are checking, you will receive an UnknownSnapshotException.
    Specified by:
    
    isSnapshotFinished in interface AsyncAdmin
    
    Parameters:
    
    snapshot - description of the snapshot to check
    
    Returns:
    
    true if the snapshot is completed, false if the snapshot is still running
  - restoreSnapshot
```
public CompletableFuture<Void> restoreSnapshot(String snapshotName)
```
    Description copied from interface: AsyncAdmin
    
    Restore the specified snapshot on the original table. (The table must be disabled) If the "hbase.snapshot.restore.take.failsafe.snapshot" configuration property is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted.
    
    Specified by:
    
    restoreSnapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
  - restoreSnapshot
```
public CompletableFuture<Void> restoreSnapshot(String snapshotName,
                                               boolean takeFailSafeSnapshot)
```
    Description copied from interface: AsyncAdmin
    
    Restore the specified snapshot on the original table. (The table must be disabled) If 'takeFailSafeSnapshot' is set to true, a snapshot of the current table is taken before executing the restore operation. In case of restore failure, the failsafe snapshot will be restored. If the restore completes without problem the failsafe snapshot is deleted. The failsafe snapshot name is configurable by using the property "hbase.snapshot.restore.failsafe.name".
    
    Specified by:
    
    restoreSnapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name of the snapshot to restore
    
    takeFailSafeSnapshot - true if the failsafe snapshot should be taken
  - cloneSnapshot
```
public CompletableFuture<Void> cloneSnapshot(String snapshotName,
                                             TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Create a new table by cloning the snapshot content.
    
    Specified by:
    
    cloneSnapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name of the snapshot to be cloned
    
    tableName - name of the table where the snapshot will be restored
  - listSnapshots
```
public CompletableFuture<List<SnapshotDescription>> listSnapshots(Optional<Pattern> pattern)
```
    Description copied from interface: AsyncAdmin
    
    List all the completed snapshots matching the given pattern.
    
    Specified by:
    
    listSnapshots in interface AsyncAdmin
    
    Parameters:
    
    pattern - The compiled regular expression to match against
    
    Returns:
    
    - returns a List of SnapshotDescription wrapped by a CompletableFuture
  - listTableSnapshots
```
public CompletableFuture<List<SnapshotDescription>> listTableSnapshots(Pattern tableNamePattern,
                                                                       Pattern snapshotNamePattern)
```
    Description copied from interface: AsyncAdmin
    
    List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Specified by:
    
    listTableSnapshots in interface AsyncAdmin
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
    
    Returns:
    
    - returns a List of completed SnapshotDescription wrapped by a CompletableFuture
  - deleteSnapshot
```
public CompletableFuture<Void> deleteSnapshot(String snapshotName)
```
    Description copied from interface: AsyncAdmin
    
    Delete an existing snapshot.
    
    Specified by:
    
    deleteSnapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name of the snapshot
  - deleteTableSnapshots
```
public CompletableFuture<Void> deleteTableSnapshots(Pattern tableNamePattern,
                                                    Pattern snapshotNamePattern)
```
    Description copied from interface: AsyncAdmin
    
    Delete all existing snapshots matching the given table name regular expression and snapshot name regular expression.
    
    Specified by:
    
    deleteTableSnapshots in interface AsyncAdmin
    
    Parameters:
    
    tableNamePattern - The compiled table name regular expression to match against
    
    snapshotNamePattern - The compiled snapshot name regular expression to match against
  - execProcedure
```
public CompletableFuture<Void> execProcedure(String signature,
                                             String instance,
                                             Map<String,String> props)
```
    Description copied from interface: AsyncAdmin
    
    Execute a distributed procedure on a cluster.
    
    Specified by:
    
    execProcedure in interface AsyncAdmin
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
  - execProcedureWithRet
```
public CompletableFuture<byte[]> execProcedureWithRet(String signature,
                                                      String instance,
                                                      Map<String,String> props)
```
    Description copied from interface: AsyncAdmin
    
    Execute a distributed procedure on a cluster.
    
    Specified by:
    
    execProcedureWithRet in interface AsyncAdmin
    
    Parameters:
    
    signature - A distributed procedure is uniquely identified by its signature (default the root ZK node name of the procedure).
    
    instance - The instance name of the procedure. For some procedures, this parameter is optional.
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    data returned after procedure execution. null if no return data.
  - isProcedureFinished
```
public CompletableFuture<Boolean> isProcedureFinished(String signature,
                                                      String instance,
                                                      Map<String,String> props)
```
    Description copied from interface: AsyncAdmin
    Check the current state of the specified procedure. There are three possible states:
    1. running - returns false
    2. finished - returns true
    3. finished with error - throws the exception that caused the procedure to fail
    Specified by:
    
    isProcedureFinished in interface AsyncAdmin
    
    Parameters:
    
    signature - The signature that uniquely identifies a procedure
    
    instance - The instance name of the procedure
    
    props - Property/Value pairs of properties passing to the procedure
    
    Returns:
    
    true if the specified procedure is finished successfully, false if it is still running. The value is wrapped by CompletableFuture
  - abortProcedure
```
public CompletableFuture<Boolean> abortProcedure(long procId,
                                                 boolean mayInterruptIfRunning)
```
    Description copied from interface: AsyncAdmin
    
    abort a procedure
    
    Specified by:
    
    abortProcedure in interface AsyncAdmin
    
    Parameters:
    
    procId - ID of the procedure to abort
    
    mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?
    
    Returns:
    
    true if aborted, false if procedure already completed or does not exist. the value is wrapped by CompletableFuture
  - getProcedures
```
public CompletableFuture<String> getProcedures()
```
    Description copied from interface: AsyncAdmin
    
    List procedures
    
    Specified by:
    
    getProcedures in interface AsyncAdmin
    
    Returns:
    
    procedure list JSON wrapped by CompletableFuture
  - getLocks
```
public CompletableFuture<String> getLocks()
```
    Description copied from interface: AsyncAdmin
    
    List locks.
    
    Specified by:
    
    getLocks in interface AsyncAdmin
    
    Returns:
    
    lock list JSON wrapped by CompletableFuture
  - decommissionRegionServers
```
public CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers,
                                                         boolean offload)
```
    Description copied from interface: AsyncAdmin
    
    Mark region server(s) as decommissioned to prevent additional regions from getting assigned to them. Optionally unload the regions on the servers. If there are multiple servers to be decommissioned, decommissioning them at the same time can prevent wasteful region movements. Region unloading is asynchronous.
    
    Specified by:
    
    decommissionRegionServers in interface AsyncAdmin
    
    Parameters:
    
    servers - The list of servers to decommission.
    
    offload - True to offload the regions from the decommissioned servers
  - listDecommissionedRegionServers
```
public CompletableFuture<List<ServerName>> listDecommissionedRegionServers()
```
    Description copied from interface: AsyncAdmin
    
    List region servers marked as decommissioned, which can not be assigned regions.
    
    Specified by:
    
    listDecommissionedRegionServers in interface AsyncAdmin
    
    Returns:
    
    List of decommissioned region servers wrapped by CompletableFuture
  - recommissionRegionServer
```
public CompletableFuture<Void> recommissionRegionServer(ServerName server,
                                                        List<byte[]> encodedRegionNames)
```
    Description copied from interface: AsyncAdmin
    
    Remove decommission marker from a region server to allow regions assignments. Load regions onto the server if a list of regions is given. Region loading is asynchronous.
    
    Specified by:
    
    recommissionRegionServer in interface AsyncAdmin
    
    Parameters:
    
    server - The server to recommission.
    
    encodedRegionNames - Regions to load onto the server.
  - getClusterStatus
```
public CompletableFuture<ClusterStatus> getClusterStatus()
```
    Specified by:
    
    getClusterStatus in interface AsyncAdmin
    
    Returns:
    
    cluster status wrapped by CompletableFuture
  - getClusterStatus
```
public CompletableFuture<ClusterStatus> getClusterStatus(EnumSet<ClusterStatus.Option> options)
```
    Specified by:
    
    getClusterStatus in interface AsyncAdmin
    
    Returns:
    
    cluster status wrapped by CompletableFuture
  - shutdown
```
public CompletableFuture<Void> shutdown()
```
    Description copied from interface: AsyncAdmin
    
    Shuts down the HBase cluster.
    
    Specified by:
    
    shutdown in interface AsyncAdmin
  - stopMaster
```
public CompletableFuture<Void> stopMaster()
```
    Description copied from interface: AsyncAdmin
    
    Shuts down the current HBase master only.
    
    Specified by:
    
    stopMaster in interface AsyncAdmin
  - stopRegionServer
```
public CompletableFuture<Void> stopRegionServer(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Stop the designated regionserver.
    
    Specified by:
    
    stopRegionServer in interface AsyncAdmin
  - updateConfiguration
```
public CompletableFuture<Void> updateConfiguration(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Update the configuration and trigger an online config change on the regionserver.
    
    Specified by:
    
    updateConfiguration in interface AsyncAdmin
    
    Parameters:
    
    serverName - : The server whose config needs to be updated.
  - updateConfiguration
```
public CompletableFuture<Void> updateConfiguration()
```
    Description copied from interface: AsyncAdmin
    
    Update the configuration and trigger an online config change on all the masters and regionservers.
    
    Specified by:
    
    updateConfiguration in interface AsyncAdmin
  - rollWALWriter
```
public CompletableFuture<Void> rollWALWriter(ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    
    Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.
    When the returned CompletableFuture is done, it only means the rollWALWriter request was sent to the region server and may need some time to finish the rollWALWriter operation. As a side effect of this call, the named region server may schedule store flushes at the request of the wal.
    
    Specified by:
    
    rollWALWriter in interface AsyncAdmin
    
    Parameters:
    
    serverName - The servername of the region server.
  - clearCompactionQueues
```
public CompletableFuture<Void> clearCompactionQueues(ServerName serverName,
                                                     Set<String> queues)
```
    Description copied from interface: AsyncAdmin
    
    Clear compacting queues on a region server.
    
    Specified by:
    
    clearCompactionQueues in interface AsyncAdmin
    
    queues - the set of queue name
  - getSecurityCapabilities
```
public CompletableFuture<List<SecurityCapability>> getSecurityCapabilities()
```
    Specified by:
    
    getSecurityCapabilities in interface AsyncAdmin
    
    Returns:
    
    the list of supported security capabilities. The return value will be wrapped by a CompletableFuture.
  - getRegionLoads
```
public CompletableFuture<List<RegionLoad>> getRegionLoads(ServerName serverName,
                                                          Optional<TableName> tableName)
```
    Description copied from interface: AsyncAdmin
    
    Get a list of RegionLoad of all regions hosted on a region seerver for a table.
    
    Specified by:
    
    getRegionLoads in interface AsyncAdmin
    
    Returns:
    
    a list of RegionLoad wrapped by CompletableFuture
  - isMasterInMaintenanceMode
```
public CompletableFuture<Boolean> isMasterInMaintenanceMode()
```
    Description copied from interface: AsyncAdmin
    
    Check whether master is in maintenance mode
    
    Specified by:
    
    isMasterInMaintenanceMode in interface AsyncAdmin
    
    Returns:
    
    true if master is in maintenance mode, false otherwise. The return value will be wrapped by a CompletableFuture
  - getCompactionState
```
public CompletableFuture<CompactionState> getCompactionState(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Get the current compaction state of a table. It could be in a major compaction, a minor compaction, both, or none.
    
    Specified by:
    
    getCompactionState in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to examine
    
    Returns:
    
    the current compaction state wrapped by a CompletableFuture
  - getCompactionStateForRegion
```
public CompletableFuture<CompactionState> getCompactionStateForRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Get the current compaction state of region. It could be in a major compaction, a minor compaction, both, or none.
    
    Specified by:
    
    getCompactionStateForRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to examine
    
    Returns:
    
    the current compaction state wrapped by a CompletableFuture
  - getLastMajorCompactionTimestamp
```
public CompletableFuture<Optional<Long>> getLastMajorCompactionTimestamp(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Get the timestamp of the last major compaction for the passed table.
    The timestamp of the oldest HFile resulting from a major compaction of that table, or not present if no such HFile could be found.
    
    Specified by:
    
    getLastMajorCompactionTimestamp in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to examine
    
    Returns:
    
    the last major compaction timestamp wrapped by a CompletableFuture
  - getLastMajorCompactionTimestampForRegion
```
public CompletableFuture<Optional<Long>> getLastMajorCompactionTimestampForRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Get the timestamp of the last major compaction for the passed region.
    The timestamp of the oldest HFile resulting from a major compaction of that region, or not present if no such HFile could be found.
    
    Specified by:
    
    getLastMajorCompactionTimestampForRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to examine
    
    Returns:
    
    the last major compaction timestamp wrapped by a CompletableFuture
  - setBalancerOn
```
public CompletableFuture<Boolean> setBalancerOn(boolean on)
```
    Description copied from interface: AsyncAdmin
    
    Turn the load balancer on or off.
    
    Specified by:
    
    setBalancerOn in interface AsyncAdmin
    
    Returns:
    
    Previous balancer value wrapped by a CompletableFuture.
  - balance
```
public CompletableFuture<Boolean> balance(boolean forcible)
```
    Description copied from interface: AsyncAdmin
    
    Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. If there is region in transition, force parameter of true would still run balancer. Can *not* run for other reasons. Check logs.
    
    Specified by:
    
    balance in interface AsyncAdmin
    
    Parameters:
    
    forcible - whether we should force balance even if there is region in transition.
    
    Returns:
    
    True if balancer ran, false otherwise. The return value will be wrapped by a CompletableFuture.
  - isBalancerOn
```
public CompletableFuture<Boolean> isBalancerOn()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the balancer.
    
    Specified by:
    
    isBalancerOn in interface AsyncAdmin
    
    Returns:
    
    true if the balance switch is on, false otherwise. The return value will be wrapped by a CompletableFuture.
  - setNormalizerOn
```
public CompletableFuture<Boolean> setNormalizerOn(boolean on)
```
    Description copied from interface: AsyncAdmin
    
    Set region normalizer on/off.
    
    Specified by:
    
    setNormalizerOn in interface AsyncAdmin
    
    Parameters:
    
    on - whether normalizer should be on or off
    
    Returns:
    
    Previous normalizer value wrapped by a CompletableFuture
  - isNormalizerOn
```
public CompletableFuture<Boolean> isNormalizerOn()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the region normalizer
    
    Specified by:
    
    isNormalizerOn in interface AsyncAdmin
    
    Returns:
    
    true if region normalizer is on, false otherwise. The return value will be wrapped by a CompletableFuture
  - normalize
```
public CompletableFuture<Boolean> normalize()
```
    Description copied from interface: AsyncAdmin
    
    Invoke region normalizer. Can NOT run for various reasons. Check logs.
    
    Specified by:
    
    normalize in interface AsyncAdmin
    
    Returns:
    
    true if region normalizer ran, false otherwise. The return value will be wrapped by a CompletableFuture
  - setCleanerChoreOn
```
public CompletableFuture<Boolean> setCleanerChoreOn(boolean enabled)
```
    Description copied from interface: AsyncAdmin
    
    Turn the cleaner chore on/off.
    
    Specified by:
    
    setCleanerChoreOn in interface AsyncAdmin
    
    Returns:
    
    Previous cleaner state wrapped by a CompletableFuture
  - isCleanerChoreOn
```
public CompletableFuture<Boolean> isCleanerChoreOn()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the cleaner chore.
    
    Specified by:
    
    isCleanerChoreOn in interface AsyncAdmin
    
    Returns:
    
    true if cleaner chore is on, false otherwise. The return value will be wrapped by a CompletableFuture
  - runCleanerChore
```
public CompletableFuture<Boolean> runCleanerChore()
```
    Description copied from interface: AsyncAdmin
    
    Ask for cleaner chore to run.
    
    Specified by:
    
    runCleanerChore in interface AsyncAdmin
    
    Returns:
    
    true if cleaner chore ran, false otherwise. The return value will be wrapped by a CompletableFuture
  - setCatalogJanitorOn
```
public CompletableFuture<Boolean> setCatalogJanitorOn(boolean enabled)
```
    Description copied from interface: AsyncAdmin
    
    Turn the catalog janitor on/off.
    
    Specified by:
    
    setCatalogJanitorOn in interface AsyncAdmin
    
    Returns:
    
    the previous state wrapped by a CompletableFuture
  - isCatalogJanitorOn
```
public CompletableFuture<Boolean> isCatalogJanitorOn()
```
    Description copied from interface: AsyncAdmin
    
    Query on the catalog janitor state.
    
    Specified by:
    
    isCatalogJanitorOn in interface AsyncAdmin
    
    Returns:
    
    true if the catalog janitor is on, false otherwise. The return value will be wrapped by a CompletableFuture
  - runCatalogJanitor
```
public CompletableFuture<Integer> runCatalogJanitor()
```
    Description copied from interface: AsyncAdmin
    
    Ask for a scan of the catalog table.
    
    Specified by:
    
    runCatalogJanitor in interface AsyncAdmin
    
    Returns:
    
    the number of entries cleaned. The return value will be wrapped by a CompletableFuture
  - coprocessorService
```
public <S,R> CompletableFuture<R> coprocessorService(Function<com.google.protobuf.RpcChannel,S> stubMaker,
                                                     RawAsyncTable.CoprocessorCallable<S,R> callable)
```
    Description copied from interface: AsyncAdmin
    Execute the given coprocessor call on the master.
    The stubMaker is just a delegation to the newStub call. Usually it is only a one line lambda expression, like:
```
 
 channel -> xxxService.newStub(channel)
 
 
```
    Specified by:
    
    coprocessorService in interface AsyncAdmin
    
    Type Parameters:
    
    S - the type of the asynchronous stub
    
    R - the type of the return value
    
    Parameters:
    
    stubMaker - a delegation to the actual newStub call.
    
    callable - a delegation to the actual protobuf rpc call. See the comment of RawAsyncTable.CoprocessorCallable for more details.
    
    Returns:
    
    the return value of the protobuf rpc call, wrapped by a CompletableFuture.
    
    See Also:
    
    RawAsyncTable.CoprocessorCallable
  - coprocessorService
```
public <S,R> CompletableFuture<R> coprocessorService(Function<com.google.protobuf.RpcChannel,S> stubMaker,
                                                     RawAsyncTable.CoprocessorCallable<S,R> callable,
                                                     ServerName serverName)
```
    Description copied from interface: AsyncAdmin
    Execute the given coprocessor call on the given region server.
    The stubMaker is just a delegation to the newStub call. Usually it is only a one line lambda expression, like:
```
 
 channel -> xxxService.newStub(channel)
 
 
```
    Specified by:
    
    coprocessorService in interface AsyncAdmin
    
    Type Parameters:
    
    S - the type of the asynchronous stub
    
    R - the type of the return value
    
    Parameters:
    
    stubMaker - a delegation to the actual newStub call.
    
    callable - a delegation to the actual protobuf rpc call. See the comment of RawAsyncTable.CoprocessorCallable for more details.
    
    serverName - the given region server
    
    Returns:
    
    the return value of the protobuf rpc call, wrapped by a CompletableFuture.
    
    See Also:
    
    RawAsyncTable.CoprocessorCallable
  - listDeadServers
```
public CompletableFuture<List<ServerName>> listDeadServers()
```
    Description copied from interface: AsyncAdmin
    
    List all the dead region servers.
    
    Specified by:
    
    listDeadServers in interface AsyncAdmin
    
    Returns:
    
    - returns a list of dead region servers wrapped by a CompletableFuture.
  - clearDeadServers
```
public CompletableFuture<List<ServerName>> clearDeadServers(List<ServerName> servers)
```
    Description copied from interface: AsyncAdmin
    
    Clear dead region servers from master.
    
    Specified by:
    
    clearDeadServers in interface AsyncAdmin
    
    Parameters:
    
    servers - list of dead region servers.
    
    Returns:
    
    - returns a list of servers that not cleared wrapped by a CompletableFuture.

Class AsyncHBaseAdmin

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.client.AsyncAdmin

Method Detail

tableExists

listTables

listTableNames

getTableDescriptor

createTable

createTable

deleteTable

truncateTable

enableTable

disableTable

isTableEnabled

isTableDisabled

isTableAvailable

addColumnFamily

deleteColumnFamily

modifyColumnFamily

createNamespace

modifyNamespace

deleteNamespace

getNamespaceDescriptor

listNamespaceDescriptors

getOnlineRegions

getTableRegions

flush

flushRegion

compact

compactRegion

majorCompact

majorCompactRegion

compactRegionServer

majorCompactRegionServer

setMergeOn

isMergeOn

setSplitOn

isSplitOn

mergeRegions

split

split

splitRegion

assign

unassign

offline

move

setQuota

getQuota

addReplicationPeer

removeReplicationPeer

enableReplicationPeer

disableReplicationPeer

getReplicationPeerConfig

updateReplicationPeerConfig

appendReplicationPeerTableCFs

removeReplicationPeerTableCFs

listReplicationPeers

listReplicatedTableCFs

snapshot

isSnapshotFinished

restoreSnapshot

restoreSnapshot

cloneSnapshot

listSnapshots

listTableSnapshots

deleteSnapshot

deleteTableSnapshots

execProcedure

execProcedureWithRet

isProcedureFinished

abortProcedure

getProcedures

getLocks

decommissionRegionServers

listDecommissionedRegionServers

recommissionRegionServer

getClusterStatus

getClusterStatus