com.google.cloud.bigtable.hbase1_x

Class BigtableAdmin

java.lang.Object

org.apache.hadoop.hbase.client.AbstractBigtableAdmin

com.google.cloud.bigtable.hbase1_x.BigtableAdmin

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, Admin

@InternalApi(value="For internal usage only")
public class BigtableAdmin
extends AbstractBigtableAdmin

This is an hbase 1.x implementation of AbstractBigtableAdmin. Most methods in this class unsupported

For internal use only - public for technical reasons.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.client.Admin

Admin.MasterSwitchType

Field Summary

Fields inherited from class org.apache.hadoop.hbase.client.AbstractBigtableAdmin

bigtableInstanceName, connection, LOG, tableAdapter, tableAdminClientWrapper

Constructor Summary

Constructors

Constructor and Description
BigtableAdmin(CommonConnection connection)

Method Summary

Modifier and Type	Method and Description
boolean	abortProcedure(long procId, boolean mayInterruptIfRunning)
Future<Boolean>	abortProcedureAsync(long procId, boolean mayInterruptIfRunning)
boolean	balancer(boolean arg0)
List<ServerName>	clearDeadServers(List<ServerName> list)
void	cloneSnapshot(String s, TableName tableName, boolean b)
void	disableTableAsync(TableName tableName)
void	enableTableAsync(TableName tableName)
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState	getCompactionState(TableName tableName)
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState	getCompactionStateForRegion(byte[] bytes)
long	getLastMajorCompactionTimestamp(TableName tableName)
long	getLastMajorCompactionTimestampForRegion(byte[] regionName)
QuotaRetriever	getQuotaRetriever(QuotaFilter filter)
List<SecurityCapability>	getSecurityCapabilities()
boolean	isBalancerEnabled()
boolean	isCleanerChoreEnabled()
boolean	isMasterInMaintenanceMode()
boolean	isNormalizerEnabled()
boolean	isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
boolean	isSplitOrMergeEnabled(Admin.MasterSwitchType arg0)
List<ServerName>	listDeadServers()
ProcedureInfo[]	listProcedures()
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots()
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots(Pattern pattern)
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listSnapshots(String regex)
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	listTableSnapshots(String tableNameRegex, String snapshotNameRegex)
boolean	normalize()
void	restoreSnapshot(String s, boolean b, boolean b1)
boolean	runCleanerChore()
boolean	setCleanerChoreRunning(boolean b)
boolean	setNormalizerRunning(boolean on)
void	setQuota(QuotaSettings quota)
boolean[]	setSplitOrMergeEnabled(boolean arg0, boolean arg1, Admin.MasterSwitchType... arg2)
void	snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
void	snapshot(String snapshotId, TableName tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse	takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)

Methods inherited from class org.apache.hadoop.hbase.client.AbstractBigtableAdmin

abort, addColumn, addColumn, assign, balancer, cloneSnapshot, cloneSnapshot, cloneSnapshot, close, closeRegion, closeRegion, closeRegion, closeRegionWithEncodedRegionName, compact, compact, compactRegion, compactRegion, compactRegionServer, convertToTableExistsException, coprocessorService, coprocessorService, createNamespace, createSplitKeys, createTable, createTable, createTable, createTable, createTableAsync, createTableAsync, deleteColumn, deleteColumn, deleteColumn, deleteNamespace, deleteRowRangeByPrefix, deleteSnapshot, deleteSnapshot, deleteSnapshots, deleteSnapshots, deleteTable, deleteTables, deleteTables, deleteTableSnapshots, deleteTableSnapshots, disableTable, disableTable, disableTables, disableTables, enableCatalogJanitor, enableTable, enableTable, enableTables, enableTables, execProcedure, execProcedureWithRet, flush, flushRegion, getAlterStatus, getAlterStatus, getAlterStatus, getBackupClusterName, getClusterName, getClusterStatus, getConfiguration, getConnection, getMasterCoprocessors, getMasterInfoPort, getNamespaceDescriptor, getOnlineRegions, getOperationTimeout, getTableDescriptor, getTableDescriptors, getTableDescriptorsByTableName, getTableNames, getTableRegions, isAborted, isCatalogJanitorEnabled, isProcedureFinished, isTableAvailable, isTableAvailable, isTableDisabled, isTableDisabled, isTableEnabled, isTableEnabled, listNamespaceDescriptors, listTableDescriptorsByNamespace, listTableNames, listTableNames, listTableNames, listTableNames, listTableNames, listTableNamesByNamespace, listTables, listTables, listTables, listTables, listTables, majorCompact, majorCompact, majorCompactRegion, majorCompactRegion, mergeRegions, modifyColumn, modifyColumns, modifyColumns, modifyNamespace, modifyTable, move, offline, restoreSnapshot, restoreSnapshot, restoreSnapshot, restoreSnapshot, rollWALWriter, runCatalogScan, setBalancerRunning, shutdown, snapshot, snapshot, snapshot, snapshotTable, split, split, splitRegion, splitRegion, stopMaster, stopRegionServer, tableExists, tableExists, toString, truncateTable, unassign, updateConfiguration, updateConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableAdmin

public BigtableAdmin(CommonConnection connection)
              throws IOException

Throws:

IOException

Method Detail

takeSnapshotAsync

public org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                                                                                           throws IOException,
                                                                                                  SnapshotCreationException

Throws:

IOException

SnapshotCreationException

disableTableAsync

public void disableTableAsync(TableName tableName)
                       throws IOException

Throws:

IOException

enableTableAsync

public void enableTableAsync(TableName tableName)
                      throws IOException

Throws:

IOException

getCompactionState

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionState(TableName tableName)
                                                                                                                throws IOException

Throws:

IOException

getCompactionStateForRegion

public org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState getCompactionStateForRegion(byte[] bytes)
                                                                                                                         throws IOException

Throws:

IOException

snapshot

public void snapshot(String snapshotId,
                     TableName tableName,
                     org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException

The snapshot will be created with the ttl configured by BigtableOptionsFactory.BIGTABLE_SNAPSHOT_DEFAULT_TTL_SECS_KEY key in the configuration. If not configured, the ttl will be set to serverside default.

Throws:

IOException

SnapshotCreationException

IllegalArgumentException

snapshot

public void snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
              throws IOException,
                     SnapshotCreationException,
                     IllegalArgumentException

Throws:

IOException

SnapshotCreationException

IllegalArgumentException

isSnapshotFinished

public boolean isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                           throws IOException,
                                  HBaseSnapshotException,
                                  UnknownSnapshotException

Throws:

IOException

HBaseSnapshotException

UnknownSnapshotException

restoreSnapshot

public void restoreSnapshot(String s,
                            boolean b,
                            boolean b1)
                     throws IOException,
                            RestoreSnapshotException

Throws:

IOException

RestoreSnapshotException

cloneSnapshot

public void cloneSnapshot(String s,
                          TableName tableName,
                          boolean b)
                   throws IOException,
                          TableExistsException,
                          RestoreSnapshotException

Throws:

IOException

TableExistsException

RestoreSnapshotException

listSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots()
                                                                                               throws IOException

Throws:

IOException

listSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(String regex)
                                                                                               throws IOException

Throws:

IOException

listSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listSnapshots(Pattern pattern)
                                                                                               throws IOException

Throws:

IOException

listTableSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(String tableNameRegex,
                                                                                                           String snapshotNameRegex)
                                                                                                    throws IOException

Throws:

IOException

listTableSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
                                                                                                           Pattern snapshotNamePattern)
                                                                                                    throws IOException

Throws:

IOException

isBalancerEnabled

public boolean isBalancerEnabled()
                          throws IOException

Throws:

IOException

getLastMajorCompactionTimestamp

public long getLastMajorCompactionTimestamp(TableName tableName)
                                     throws IOException

Throws:

IOException

getLastMajorCompactionTimestampForRegion

public long getLastMajorCompactionTimestampForRegion(byte[] regionName)
                                              throws IOException

Throws:

IOException

setQuota

public void setQuota(QuotaSettings quota)
              throws IOException

Throws:

IOException

getQuotaRetriever

public QuotaRetriever getQuotaRetriever(QuotaFilter filter)
                                 throws IOException

Throws:

IOException

normalize

public boolean normalize()
                  throws IOException

Throws:

IOException

isNormalizerEnabled

public boolean isNormalizerEnabled()
                            throws IOException

Throws:

IOException

setNormalizerRunning

public boolean setNormalizerRunning(boolean on)
                             throws IOException

Throws:

IOException

setCleanerChoreRunning

public boolean setCleanerChoreRunning(boolean b)
                               throws IOException

Throws:

IOException

runCleanerChore

public boolean runCleanerChore()
                        throws IOException

Throws:

IOException

isCleanerChoreEnabled

public boolean isCleanerChoreEnabled()
                              throws IOException

Throws:

IOException

isMasterInMaintenanceMode

public boolean isMasterInMaintenanceMode()
                                  throws IOException

Throws:

IOException

abortProcedure

public boolean abortProcedure(long procId,
                              boolean mayInterruptIfRunning)
                       throws IOException

Throws:

IOException

listProcedures

public ProcedureInfo[] listProcedures()
                               throws IOException

Throws:

IOException

abortProcedureAsync

public Future<Boolean> abortProcedureAsync(long procId,
                                           boolean mayInterruptIfRunning)
                                    throws IOException

Throws:

IOException

getSecurityCapabilities

public List<SecurityCapability> getSecurityCapabilities()
                                                 throws IOException

Throws:

IOException

balancer

public boolean balancer(boolean arg0)
                 throws IOException

Throws:

IOException

isSplitOrMergeEnabled

public boolean isSplitOrMergeEnabled(Admin.MasterSwitchType arg0)
                              throws IOException

Throws:

IOException

listDeadServers

public List<ServerName> listDeadServers()
                                 throws IOException

Throws:

IOException

clearDeadServers

public List<ServerName> clearDeadServers(List<ServerName> list)
                                  throws IOException

Throws:

IOException

setSplitOrMergeEnabled

public boolean[] setSplitOrMergeEnabled(boolean arg0,
                                        boolean arg1,
                                        Admin.MasterSwitchType... arg2)
                                 throws IOException

Throws:

IOException