AsyncHBaseAdmin (Apache HBase - Client 2.0.0-alpha-1 API)

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

All Implemented Interfaces:: AsyncAdmin

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class AsyncHBaseAdmin
extends Object
implements AsyncAdmin

The implementation of AsyncAdmin.

Field Summary

Fields
Modifier and Type Field and Description

static String FLUSH_TABLE_PROCEDURE_SIGNATURE

Fields
Modifier and Type	Field and Description
`static String`	`FLUSH_TABLE_PROCEDURE_SIGNATURE`

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, HColumnDescriptor 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 id, Map<TableName,? extends Collection<String>> tableCfs)` Append the replicable table-cf config of the specified peer
`CompletableFuture<Void>`	`assign(byte[] regionName)`
`CompletableFuture<Boolean>`	`balancer()` Invoke the balancer.
`CompletableFuture<Boolean>`	`balancer(boolean force)` Invoke the balancer.
`CompletableFuture<Void>`	`cloneSnapshot(String snapshotName, TableName tableName)` Create a new table by cloning the snapshot content.
`CompletableFuture<Void>`	`closeRegion(byte[] regionName, String serverName)` Close a region.
`CompletableFuture<Void>`	`closeRegion(ServerName sn, HRegionInfo hri)` Close a region.
`CompletableFuture<Void>`	`closeRegion(String regionname, String serverName)` Close a region.
`CompletableFuture<Boolean>`	`closeRegionWithEncodedRegionName(String encodedRegionName, String serverName)` For expert-admins.
`CompletableFuture<Void>`	`compact(TableName tableName)` Compact a table.
`CompletableFuture<Void>`	`compact(TableName tableName, byte[] columnFamily)` Compact a column family within a table.
`CompletableFuture<Void>`	`compactRegion(byte[] regionName)` Compact an individual region.
`CompletableFuture<Void>`	`compactRegion(byte[] regionName, byte[] columnFamily)` Compact a column family within a region.
`CompletableFuture<Void>`	`compactRegionServer(ServerName sn)` Compact all regions on the region server.
`CompletableFuture<Void>`	`createNamespace(NamespaceDescriptor descriptor)` Create a new namespace.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc)` Creates a new table.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, byte[][] splitKeys)` Creates a new table with an initial set of empty regions defined by the specified split keys.
`CompletableFuture<Void>`	`createTable(TableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions)` Creates a new table with the specified number of regions.
`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>`	`deleteSnapshots(Pattern snapshotNamePattern)` Delete existing snapshots whose names match the pattern passed.
`CompletableFuture<Void>`	`deleteSnapshots(String regex)` Delete existing snapshots whose names match the pattern passed.
`CompletableFuture<Void>`	`deleteTable(TableName tableName)` Deletes a table.
`CompletableFuture<TableDescriptor[]>`	`deleteTables(Pattern pattern)` Delete tables matching the passed in pattern and wait on completion.
`CompletableFuture<TableDescriptor[]>`	`deleteTables(String regex)` Deletes tables matching the passed in pattern and wait on completion.
`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>`	`deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex)` 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<TableDescriptor[]>`	`disableTables(Pattern pattern)` Disable tables matching the passed in pattern.
`CompletableFuture<TableDescriptor[]>`	`disableTables(String regex)` Disable tables matching the passed in pattern.
`CompletableFuture<Void>`	`enableReplicationPeer(String peerId)` Restart the replication stream to the specified peer
`CompletableFuture<Void>`	`enableTable(TableName tableName)` Enable a table.
`CompletableFuture<TableDescriptor[]>`	`enableTables(Pattern pattern)` Enable tables matching the passed in pattern.
`CompletableFuture<TableDescriptor[]>`	`enableTables(String regex)` Enable tables matching the passed in pattern.
`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<Pair<Integer,Integer>>`	`getAlterStatus(TableName tableName)` Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
`org.apache.hadoop.hbase.client.AsyncConnectionImpl`	`getConnection()`
`CompletableFuture<NamespaceDescriptor>`	`getNamespaceDescriptor(String name)` Get a namespace descriptor by name
`CompletableFuture<List<HRegionInfo>>`	`getOnlineRegions(ServerName sn)` Get all the online regions on a region server.
`CompletableFuture<List<QuotaSettings>>`	`getQuota(QuotaFilter filter)` List the quotas based on the filter.
`CompletableFuture<ReplicationPeerConfig>`	`getReplicationPeerConfig(String peerId)` Returns the configured ReplicationPeerConfig for the specified peer
`CompletableFuture<TableDescriptor>`	`getTableDescriptor(TableName tableName)` Method for getting the tableDescriptor
`CompletableFuture<Boolean>`	`isBalancerEnabled()` Query the current state of the balancer.
`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>`	`isTableAvailable(TableName tableName)`
`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<NamespaceDescriptor[]>`	`listNamespaceDescriptors()` List available namespace descriptors
`CompletableFuture<ProcedureInfo[]>`	`listProcedures()` List procedures
`CompletableFuture<List<TableCFs>>`	`listReplicatedTableCFs()` Find all table and column families that are replicated from this cluster
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers()` Return a list of replication peers.
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers(Pattern pattern)` Return a list of replication peers.
`CompletableFuture<List<ReplicationPeerDescription>>`	`listReplicationPeers(String regex)` Return a list of replication peers.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots()` List completed snapshots.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots(Pattern pattern)` List all the completed snapshots matching the given pattern.
`CompletableFuture<List<SnapshotDescription>>`	`listSnapshots(String regex)` List all the completed snapshots matching the given regular expression.
`CompletableFuture<TableName[]>`	`listTableNames()` List all of the names of userspace tables.
`CompletableFuture<TableName[]>`	`listTableNames(Pattern pattern, boolean includeSysTables)` List all of the names of userspace tables.
`CompletableFuture<TableName[]>`	`listTableNames(String regex, boolean includeSysTables)` List all of the names of userspace tables.
`CompletableFuture<TableDescriptor[]>`	`listTables()` List all the userspace tables.
`CompletableFuture<TableDescriptor[]>`	`listTables(Pattern pattern, boolean includeSysTables)` List all the tables matching the given pattern.
`CompletableFuture<TableDescriptor[]>`	`listTables(String regex, 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<List<SnapshotDescription>>`	`listTableSnapshots(String tableNameRegex, String snapshotNameRegex)` List all the completed snapshots matching the given table name regular expression and snapshot name regular expression.
`CompletableFuture<Void>`	`majorCompact(TableName tableName)` Major compact a table.
`CompletableFuture<Void>`	`majorCompact(TableName tableName, byte[] columnFamily)` Major compact a column family within a table.
`CompletableFuture<Void>`	`majorCompactRegion(byte[] regionName)` Major compact a table or an individual region.
`CompletableFuture<Void>`	`majorCompactRegion(byte[] regionName, byte[] columnFamily)` Major compact a column family within region.
`CompletableFuture<Void>`	`majorCompactRegionServer(ServerName sn)` Compact all regions on the region server.
`CompletableFuture<Void>`	`mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible)` Merge two regions.
`CompletableFuture<Void>`	`modifyColumnFamily(TableName tableName, HColumnDescriptor columnFamily)` Modify an existing column family on a table.
`CompletableFuture<Void>`	`modifyNamespace(NamespaceDescriptor descriptor)` Modify an existing namespace.
`CompletableFuture<Void>`	`move(byte[] regionName, byte[] destServerName)` Move the region `r` to `dest`.
`CompletableFuture<Void>`	`offline(byte[] regionName)` Offline specified region from master's in-memory state.
`CompletableFuture<Void>`	`removeReplicationPeer(String peerId)` Remove a peer and stop the replication
`CompletableFuture<Void>`	`removeReplicationPeerTableCFs(String id, 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<Boolean>`	`setBalancerRunning(boolean on)` Turn the load balancer on or off.
`CompletableFuture<Void>`	`setQuota(QuotaSettings quota)` Apply the new quota settings.
`CompletableFuture<Void>`	`snapshot(SnapshotDescription snapshotDesc)` Take a snapshot and wait for the server to complete that snapshot asynchronously.
`CompletableFuture<Void>`	`snapshot(String snapshotName, TableName tableName)` Take a snapshot for the given table.
`CompletableFuture<Void>`	`snapshot(String snapshotName, TableName tableName, SnapshotType type)` Create typed snapshot of the table.
`CompletableFuture<Void>`	`split(ServerName sn, HRegionInfo hri, byte[] splitPoint)`
`CompletableFuture<Void>`	`split(TableName tableName)` Split a table.
`CompletableFuture<Void>`	`split(TableName tableName, byte[] splitPoint)` Split a table.
`CompletableFuture<Void>`	`splitRegion(byte[] regionName)` Split an individual region.
`CompletableFuture<Void>`	`splitRegion(byte[] regionName, byte[] splitPoint)` Split an individual region.
`CompletableFuture<Boolean>`	`tableExists(TableName tableName)`
`CompletableFuture<Void>`	`truncateTable(TableName tableName, boolean preserveSplits)` Truncate a table.
`CompletableFuture<Void>`	`unassign(byte[] regionName, boolean force)` Unassign a region from current hosting 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

- Field Detail
  - FLUSH_TABLE_PROCEDURE_SIGNATURE
```
public static final String FLUSH_TABLE_PROCEDURE_SIGNATURE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getConnection
```
public org.apache.hadoop.hbase.client.AsyncConnectionImpl getConnection()
```
    Specified by:
    
    getConnection in interface AsyncAdmin
    
    Returns:
    
    Async Connection used by this object.
  - 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<TableDescriptor[]> listTables()
```
    Description copied from interface: AsyncAdmin
    
    List all the userspace tables.
    
    Specified by:
    
    listTables in interface AsyncAdmin
    
    Returns:
    
    - returns an array of TableDescriptors wrapped by a CompletableFuture.
    
    See Also:
    
    AsyncAdmin.listTables(Pattern, boolean)
  - listTables
```
public CompletableFuture<TableDescriptor[]> listTables(String regex,
                                                       boolean includeSysTables)
```
    Description copied from interface: AsyncAdmin
    
    List all the tables matching the given pattern.
    
    Specified by:
    
    listTables in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    - returns an array of TableDescriptors wrapped by a CompletableFuture.
    
    See Also:
    
    AsyncAdmin.listTables(Pattern, boolean)
  - listTables
```
public CompletableFuture<TableDescriptor[]> listTables(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 an array of TableDescriptors wrapped by a CompletableFuture.
  - listTableNames
```
public CompletableFuture<TableName[]> listTableNames()
```
    Description copied from interface: AsyncAdmin
    
    List all of the names of userspace tables.
    
    Specified by:
    
    listTableNames in interface AsyncAdmin
    
    Returns:
    
    TableName[] an array of table names wrapped by a CompletableFuture.
    
    See Also:
    
    AsyncAdmin.listTableNames(Pattern, boolean)
  - listTableNames
```
public CompletableFuture<TableName[]> listTableNames(String regex,
                                                     boolean includeSysTables)
```
    Description copied from interface: AsyncAdmin
    
    List all of the names of userspace tables.
    
    Specified by:
    
    listTableNames in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match against
    
    includeSysTables - False to match only against userspace tables
    
    Returns:
    
    TableName[] an array of table names wrapped by a CompletableFuture.
    
    See Also:
    
    AsyncAdmin.listTableNames(Pattern, boolean)
  - listTableNames
```
public CompletableFuture<TableName[]> listTableNames(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:
    
    TableName[] an array 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)
```
    Description copied from interface: AsyncAdmin
    
    Creates a new table.
    
    Specified by:
    
    createTable in interface AsyncAdmin
    
    Parameters:
    
    desc - table descriptor for table
  - 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,
                                           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
  - deleteTables
```
public CompletableFuture<TableDescriptor[]> deleteTables(String regex)
```
    Description copied from interface: AsyncAdmin
    
    Deletes tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(String, boolean) and AsyncAdmin.deleteTable(org.apache.hadoop.hbase.TableName)
    
    Specified by:
    
    deleteTables in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - deleteTables
```
public CompletableFuture<TableDescriptor[]> deleteTables(Pattern pattern)
```
    Description copied from interface: AsyncAdmin
    
    Delete tables matching the passed in pattern and wait on completion. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(Pattern, boolean) and AsyncAdmin.deleteTable(org.apache.hadoop.hbase.TableName)
    
    Specified by:
    
    deleteTables in interface AsyncAdmin
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be deleted. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - 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
  - enableTables
```
public CompletableFuture<TableDescriptor[]> enableTables(String regex)
```
    Description copied from interface: AsyncAdmin
    
    Enable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(Pattern, boolean) and AsyncAdmin.enableTable(TableName)
    
    Specified by:
    
    enableTables in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - enableTables
```
public CompletableFuture<TableDescriptor[]> enableTables(Pattern pattern)
```
    Description copied from interface: AsyncAdmin
    
    Enable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(Pattern, boolean) and AsyncAdmin.enableTable(TableName)
    
    Specified by:
    
    enableTables in interface AsyncAdmin
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be enabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - 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
  - disableTables
```
public CompletableFuture<TableDescriptor[]> disableTables(String regex)
```
    Description copied from interface: AsyncAdmin
    
    Disable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(Pattern, boolean) and AsyncAdmin.disableTable(TableName)
    
    Specified by:
    
    disableTables in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - disableTables
```
public CompletableFuture<TableDescriptor[]> disableTables(Pattern pattern)
```
    Description copied from interface: AsyncAdmin
    
    Disable tables matching the passed in pattern. Warning: Use this method carefully, there is no prompting and the effect is immediate. Consider using AsyncAdmin.listTables(Pattern, boolean) and AsyncAdmin.disableTable(TableName)
    
    Specified by:
    
    disableTables in interface AsyncAdmin
    
    Parameters:
    
    pattern - The pattern to match table names against
    
    Returns:
    
    Table descriptors for tables that couldn't be disabled. The return value will be wrapped by a CompletableFuture. The return HTDs are read-only.
  - 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)
```
    Specified by:
    
    isTableAvailable in interface AsyncAdmin
    
    Parameters:
    
    tableName - name of table to check
    
    Returns:
    
    true if all regions of the table are available. 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
  - getAlterStatus
```
public CompletableFuture<Pair<Integer,Integer>> getAlterStatus(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
    
    Specified by:
    
    getAlterStatus in interface AsyncAdmin
    
    Parameters:
    
    tableName - TableName instance
    
    Returns:
    
    Pair indicating the number of regions updated Pair.getFirst() is the regions that are yet to be updated Pair.getSecond() is the total number of regions of the table. The return value will be wrapped by a CompletableFuture.
  - addColumnFamily
```
public CompletableFuture<Void> addColumnFamily(TableName tableName,
                                               HColumnDescriptor 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,
                                                  HColumnDescriptor 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<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.
  - setBalancerRunning
```
public CompletableFuture<Boolean> setBalancerRunning(boolean on)
```
    Description copied from interface: AsyncAdmin
    
    Turn the load balancer on or off.
    
    Specified by:
    
    setBalancerRunning in interface AsyncAdmin
    
    Returns:
    
    Previous balancer value wrapped by a CompletableFuture.
  - balancer
```
public CompletableFuture<Boolean> balancer()
```
    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. Can NOT run for various reasons. Check logs.
    
    Specified by:
    
    balancer in interface AsyncAdmin
    
    Returns:
    
    True if balancer ran, false otherwise. The return value will be wrapped by a CompletableFuture.
  - balancer
```
public CompletableFuture<Boolean> balancer(boolean force)
```
    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:
    
    balancer in interface AsyncAdmin
    
    Parameters:
    
    force - 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.
  - isBalancerEnabled
```
public CompletableFuture<Boolean> isBalancerEnabled()
```
    Description copied from interface: AsyncAdmin
    
    Query the current state of the balancer.
    
    Specified by:
    
    isBalancerEnabled in interface AsyncAdmin
    
    Returns:
    
    true if the balancer is enabled, false otherwise. The return value will be wrapped by a CompletableFuture.
  - closeRegion
```
public CompletableFuture<Void> closeRegion(String regionname,
                                           String serverName)
```
    Description copied from interface: AsyncAdmin
    
    Close a region. For expert-admins. Runs close on the regionserver. The master will not be informed of the close.
    
    Specified by:
    
    closeRegion in interface AsyncAdmin
    
    Parameters:
    
    regionname - region name to close
    
    serverName - If supplied, we'll use this location rather than the one currently in hbase:meta
  - closeRegion
```
public CompletableFuture<Void> closeRegion(byte[] regionName,
                                           String serverName)
```
    Description copied from interface: AsyncAdmin
    
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    Specified by:
    
    closeRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region name to close
    
    serverName - The servername of the regionserver. If passed null we will use servername found in the hbase:meta table. A server name is made of host, port and startcode. Here is an example: host187.example.com,60020,1289493121758
  - closeRegionWithEncodedRegionName
```
public CompletableFuture<Boolean> closeRegionWithEncodedRegionName(String encodedRegionName,
                                                                   String serverName)
```
    Description copied from interface: AsyncAdmin
    
    For expert-admins. Runs close on the regionserver. Closes a region based on the encoded region name. The region server name is mandatory. If the servername is provided then based on the online regions in the specified regionserver the specified region will be closed. The master will not be informed of the close. Note that the regionname is the encoded regionname.
    
    Specified by:
    
    closeRegionWithEncodedRegionName in interface AsyncAdmin
    
    Parameters:
    
    encodedRegionName - The encoded region name; i.e. the hash that makes up the region name suffix: e.g. if regionname is TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396., then the encoded region name is: 527db22f95c8a9e0116f0cc13c680396.
    
    serverName - The servername of the regionserver. A server name is made of host, port and startcode. This is mandatory. Here is an example: host187.example.com,60020,1289493121758
    
    Returns:
    
    true if the region was closed, false if not. The return value will be wrapped by a CompletableFuture.
  - closeRegion
```
public CompletableFuture<Void> closeRegion(ServerName sn,
                                           HRegionInfo hri)
```
    Description copied from interface: AsyncAdmin
    
    Close a region. For expert-admins Runs close on the regionserver. The master will not be informed of the close.
    
    Specified by:
    
    closeRegion in interface AsyncAdmin
  - getOnlineRegions
```
public CompletableFuture<List<HRegionInfo>> getOnlineRegions(ServerName sn)
```
    Description copied from interface: AsyncAdmin
    
    Get all the online regions on a region server.
    
    Specified by:
    
    getOnlineRegions 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)
```
    Description copied from interface: AsyncAdmin
    
    Compact a table. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    compact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to compact
  - compact
```
public CompletableFuture<Void> compact(TableName tableName,
                                       byte[] columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Compact a column family within a table. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    compact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to compact
    
    columnFamily - column family within a table
  - compactRegion
```
public CompletableFuture<Void> compactRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Compact an individual region. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    compactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to compact
  - compactRegion
```
public CompletableFuture<Void> compactRegion(byte[] regionName,
                                             byte[] columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Compact a column family within a region. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    compactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to compact
    
    columnFamily - column family within a region
  - majorCompact
```
public CompletableFuture<Void> majorCompact(TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a table. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    majorCompact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to major compact
  - majorCompact
```
public CompletableFuture<Void> majorCompact(TableName tableName,
                                            byte[] columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a column family within a table. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    majorCompact in interface AsyncAdmin
    
    Parameters:
    
    tableName - table to major compact
    
    columnFamily - column family within a table
  - majorCompactRegion
```
public CompletableFuture<Void> majorCompactRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a table or an individual region. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    majorCompactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region to major compact
  - majorCompactRegion
```
public CompletableFuture<Void> majorCompactRegion(byte[] regionName,
                                                  byte[] columnFamily)
```
    Description copied from interface: AsyncAdmin
    
    Major compact a column family within region. Asynchronous operation even if CompletableFuture.get().
    
    Specified by:
    
    majorCompactRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - egion to major compact
    
    columnFamily - column family within a region
  - compactRegionServer
```
public CompletableFuture<Void> compactRegionServer(ServerName sn)
```
    Description copied from interface: AsyncAdmin
    
    Compact all regions on the region server.
    
    Specified by:
    
    compactRegionServer in interface AsyncAdmin
    
    Parameters:
    
    sn - the region server name
  - majorCompactRegionServer
```
public CompletableFuture<Void> majorCompactRegionServer(ServerName sn)
```
    Description copied from interface: AsyncAdmin
    
    Compact all regions on the region server.
    
    Specified by:
    
    majorCompactRegionServer in interface AsyncAdmin
    
    Parameters:
    
    sn - the region server name
  - 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
  - splitRegion
```
public CompletableFuture<Void> splitRegion(byte[] regionName)
```
    Description copied from interface: AsyncAdmin
    
    Split an individual region.
    
    Specified by:
    
    splitRegion in interface AsyncAdmin
    
    Parameters:
    
    regionName - region 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,
                                           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
  - split
```
public CompletableFuture<Void> split(ServerName sn,
                                     HRegionInfo hri,
                                     byte[] splitPoint)
```
  - 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 force)
```
    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[], byte[]) 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.
    
    force - 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,
                                    byte[] 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 passed the empty byte array 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 id,
                                                             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:
    
    id - a short that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - removeReplicationPeerTableCFs
```
public CompletableFuture<Void> removeReplicationPeerTableCFs(String id,
                                                             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:
    
    id - a short name that identifies the cluster
    
    tableCfs - A map from tableName to column family names
  - listReplicationPeers
```
public CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers()
```
    Description copied from interface: AsyncAdmin
    
    Return a list of replication peers.
    
    Specified by:
    
    listReplicationPeers in interface AsyncAdmin
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicationPeers
```
public CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(String regex)
```
    Description copied from interface: AsyncAdmin
    
    Return a list of replication peers.
    
    Specified by:
    
    listReplicationPeers in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match peer id
    
    Returns:
    
    a list of replication peers description. The return value will be wrapped by a CompletableFuture.
  - listReplicationPeers
```
public CompletableFuture<List<ReplicationPeerDescription>> listReplicationPeers(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(String snapshotName,
                                        TableName tableName)
```
    Description copied from interface: AsyncAdmin
    
    Take a snapshot for the given table. If the table is enabled, a FLUSH-type snapshot will be taken. If the table is disabled, an offline snapshot is taken. 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[]).
    
    Specified by:
    
    snapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name of the snapshot to be created
    
    tableName - name of the table for which snapshot is created
  - snapshot
```
public CompletableFuture<Void> snapshot(String snapshotName,
                                        TableName tableName,
                                        SnapshotType type)
```
    Description copied from interface: AsyncAdmin
    
    Create typed snapshot of the table. 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[]).
    
    Specified by:
    
    snapshot in interface AsyncAdmin
    
    Parameters:
    
    snapshotName - name to give the snapshot on the filesystem. Must be unique from all other snapshots stored on the cluster
    
    tableName - name of the table to snapshot
    
    type - type of snapshot to take
  - snapshot
```
public CompletableFuture<Void> snapshot(SnapshotDescription snapshotDesc)
```
    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:
    
    snapshotDesc - 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()
```
    Description copied from interface: AsyncAdmin
    
    List completed snapshots.
    
    Specified by:
    
    listSnapshots in interface AsyncAdmin
    
    Returns:
    
    a list of snapshot descriptors for completed snapshots wrapped by a CompletableFuture
  - listSnapshots
```
public CompletableFuture<List<SnapshotDescription>> listSnapshots(String regex)
```
    Description copied from interface: AsyncAdmin
    
    List all the completed snapshots matching the given regular expression.
    
    Specified by:
    
    listSnapshots in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match against
    
    Returns:
    
    - returns a List of SnapshotDescription wrapped by a CompletableFuture
  - listSnapshots
```
public CompletableFuture<List<SnapshotDescription>> listSnapshots(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(String tableNameRegex,
                                                                       String snapshotNameRegex)
```
    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:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
    
    Returns:
    
    - returns a List of completed 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
  - deleteSnapshots
```
public CompletableFuture<Void> deleteSnapshots(String regex)
```
    Description copied from interface: AsyncAdmin
    
    Delete existing snapshots whose names match the pattern passed.
    
    Specified by:
    
    deleteSnapshots in interface AsyncAdmin
    
    Parameters:
    
    regex - The regular expression to match against
  - deleteSnapshots
```
public CompletableFuture<Void> deleteSnapshots(Pattern snapshotNamePattern)
```
    Description copied from interface: AsyncAdmin
    
    Delete existing snapshots whose names match the pattern passed.
    
    Specified by:
    
    deleteSnapshots in interface AsyncAdmin
    
    Parameters:
    
    snapshotNamePattern - pattern for names of the snapshot to match
  - deleteTableSnapshots
```
public CompletableFuture<Void> deleteTableSnapshots(String tableNameRegex,
                                                    String snapshotNameRegex)
```
    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:
    
    tableNameRegex - The table name regular expression to match against
    
    snapshotNameRegex - The snapshot name regular expression to match against
  - 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 vrapped 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
  - listProcedures
```
public CompletableFuture<ProcedureInfo[]> listProcedures()
```
    Description copied from interface: AsyncAdmin
    
    List procedures
    
    Specified by:
    
    listProcedures in interface AsyncAdmin
    
    Returns:
    
    procedure list wrapped by CompletableFuture

Class AsyncHBaseAdmin

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLUSH_TABLE_PROCEDURE_SIGNATURE

Method Detail

getConnection

tableExists

listTables

listTables

listTables

listTableNames

listTableNames

listTableNames

getTableDescriptor

createTable

createTable

createTable

deleteTable

deleteTables

deleteTables

truncateTable

enableTable

enableTables

enableTables

disableTable

disableTables

disableTables

isTableEnabled

isTableDisabled

isTableAvailable

isTableAvailable

getAlterStatus

addColumnFamily

deleteColumnFamily

modifyColumnFamily

createNamespace

modifyNamespace

deleteNamespace

getNamespaceDescriptor

listNamespaceDescriptors

setBalancerRunning

balancer

balancer

isBalancerEnabled

closeRegion

closeRegion

closeRegionWithEncodedRegionName

closeRegion

getOnlineRegions

flush

flushRegion

compact

compact

compactRegion

compactRegion

majorCompact

majorCompact

majorCompactRegion

majorCompactRegion

compactRegionServer

majorCompactRegionServer

mergeRegions

split

splitRegion

split

splitRegion

split

assign

unassign

offline

move

setQuota

getQuota

addReplicationPeer

removeReplicationPeer

enableReplicationPeer

disableReplicationPeer

getReplicationPeerConfig