Represents a BigtableTableAdmin
Inheritance
$protobuf.rpc.Service > protos.google.bigtable.admin.v2.BigtableTableAdminPackage
@google-cloud/bigtableConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new BigtableTableAdmin service.
Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Methods
checkConsistency(request, callback)
public checkConsistency(request: google.bigtable.admin.v2.ICheckConsistencyRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistencyCallback): void;
Calls CheckConsistency.
Name | Description |
request |
ICheckConsistencyRequest
CheckConsistencyRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistencyCallback
Node-style callback called with the error, if any, and CheckConsistencyResponse |
Type | Description |
void |
checkConsistency(request)
public checkConsistency(request: google.bigtable.admin.v2.ICheckConsistencyRequest): Promise<google.bigtable.admin.v2.CheckConsistencyResponse>;
Calls CheckConsistency.
Name | Description |
request |
ICheckConsistencyRequest
CheckConsistencyRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.CheckConsistencyResponse> | Promise |
create(rpcImpl, requestDelimited, responseDelimited)
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BigtableTableAdmin;
Creates new BigtableTableAdmin service using the specified rpc implementation.
Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Type | Description |
BigtableTableAdmin | RPC service. Useful where requests and/or responses are streamed. |
createBackup(request, callback)
public createBackup(request: google.bigtable.admin.v2.ICreateBackupRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.CreateBackupCallback): void;
Calls CreateBackup.
Name | Description |
request |
ICreateBackupRequest
CreateBackupRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.CreateBackupCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
createBackup(request)
public createBackup(request: google.bigtable.admin.v2.ICreateBackupRequest): Promise<google.longrunning.Operation>;
Calls CreateBackup.
Name | Description |
request |
ICreateBackupRequest
CreateBackupRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
createTable(request, callback)
public createTable(request: google.bigtable.admin.v2.ICreateTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.CreateTableCallback): void;
Calls CreateTable.
Name | Description |
request |
ICreateTableRequest
CreateTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.CreateTableCallback
Node-style callback called with the error, if any, and Table |
Type | Description |
void |
createTable(request)
public createTable(request: google.bigtable.admin.v2.ICreateTableRequest): Promise<google.bigtable.admin.v2.Table>;
Calls CreateTable.
Name | Description |
request |
ICreateTableRequest
CreateTableRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Table> | Promise |
createTableFromSnapshot(request, callback)
public createTableFromSnapshot(request: google.bigtable.admin.v2.ICreateTableFromSnapshotRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshotCallback): void;
Calls CreateTableFromSnapshot.
Name | Description |
request |
ICreateTableFromSnapshotRequest
CreateTableFromSnapshotRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshotCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
createTableFromSnapshot(request)
public createTableFromSnapshot(request: google.bigtable.admin.v2.ICreateTableFromSnapshotRequest): Promise<google.longrunning.Operation>;
Calls CreateTableFromSnapshot.
Name | Description |
request |
ICreateTableFromSnapshotRequest
CreateTableFromSnapshotRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
deleteBackup(request, callback)
public deleteBackup(request: google.bigtable.admin.v2.IDeleteBackupRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackupCallback): void;
Calls DeleteBackup.
Name | Description |
request |
IDeleteBackupRequest
DeleteBackupRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackupCallback
Node-style callback called with the error, if any, and Empty |
Type | Description |
void |
deleteBackup(request)
public deleteBackup(request: google.bigtable.admin.v2.IDeleteBackupRequest): Promise<google.protobuf.Empty>;
Calls DeleteBackup.
Name | Description |
request |
IDeleteBackupRequest
DeleteBackupRequest message or plain object |
Type | Description |
Promise<google.protobuf.Empty> | Promise |
deleteSnapshot(request, callback)
public deleteSnapshot(request: google.bigtable.admin.v2.IDeleteSnapshotRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshotCallback): void;
Calls DeleteSnapshot.
Name | Description |
request |
IDeleteSnapshotRequest
DeleteSnapshotRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshotCallback
Node-style callback called with the error, if any, and Empty |
Type | Description |
void |
deleteSnapshot(request)
public deleteSnapshot(request: google.bigtable.admin.v2.IDeleteSnapshotRequest): Promise<google.protobuf.Empty>;
Calls DeleteSnapshot.
Name | Description |
request |
IDeleteSnapshotRequest
DeleteSnapshotRequest message or plain object |
Type | Description |
Promise<google.protobuf.Empty> | Promise |
deleteTable(request, callback)
public deleteTable(request: google.bigtable.admin.v2.IDeleteTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.DeleteTableCallback): void;
Calls DeleteTable.
Name | Description |
request |
IDeleteTableRequest
DeleteTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.DeleteTableCallback
Node-style callback called with the error, if any, and Empty |
Type | Description |
void |
deleteTable(request)
public deleteTable(request: google.bigtable.admin.v2.IDeleteTableRequest): Promise<google.protobuf.Empty>;
Calls DeleteTable.
Name | Description |
request |
IDeleteTableRequest
DeleteTableRequest message or plain object |
Type | Description |
Promise<google.protobuf.Empty> | Promise |
dropRowRange(request, callback)
public dropRowRange(request: google.bigtable.admin.v2.IDropRowRangeRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.DropRowRangeCallback): void;
Calls DropRowRange.
Name | Description |
request |
IDropRowRangeRequest
DropRowRangeRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.DropRowRangeCallback
Node-style callback called with the error, if any, and Empty |
Type | Description |
void |
dropRowRange(request)
public dropRowRange(request: google.bigtable.admin.v2.IDropRowRangeRequest): Promise<google.protobuf.Empty>;
Calls DropRowRange.
Name | Description |
request |
IDropRowRangeRequest
DropRowRangeRequest message or plain object |
Type | Description |
Promise<google.protobuf.Empty> | Promise |
generateConsistencyToken(request, callback)
public generateConsistencyToken(request: google.bigtable.admin.v2.IGenerateConsistencyTokenRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyTokenCallback): void;
Calls GenerateConsistencyToken.
Name | Description |
request |
IGenerateConsistencyTokenRequest
GenerateConsistencyTokenRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyTokenCallback
Node-style callback called with the error, if any, and GenerateConsistencyTokenResponse |
Type | Description |
void |
generateConsistencyToken(request)
public generateConsistencyToken(request: google.bigtable.admin.v2.IGenerateConsistencyTokenRequest): Promise<google.bigtable.admin.v2.GenerateConsistencyTokenResponse>;
Calls GenerateConsistencyToken.
Name | Description |
request |
IGenerateConsistencyTokenRequest
GenerateConsistencyTokenRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.GenerateConsistencyTokenResponse> | Promise |
getBackup(request, callback)
public getBackup(request: google.bigtable.admin.v2.IGetBackupRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.GetBackupCallback): void;
Calls GetBackup.
Name | Description |
request |
IGetBackupRequest
GetBackupRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.GetBackupCallback
Node-style callback called with the error, if any, and Backup |
Type | Description |
void |
getBackup(request)
public getBackup(request: google.bigtable.admin.v2.IGetBackupRequest): Promise<google.bigtable.admin.v2.Backup>;
Calls GetBackup.
Name | Description |
request |
IGetBackupRequest
GetBackupRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Backup> | Promise |
getIamPolicy(request, callback)
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.GetIamPolicyCallback): void;
Calls GetIamPolicy.
Name | Description |
request |
google.iam.v1.IGetIamPolicyRequest
GetIamPolicyRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.GetIamPolicyCallback
Node-style callback called with the error, if any, and Policy |
Type | Description |
void |
getIamPolicy(request)
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;
Calls GetIamPolicy.
Name | Description |
request |
google.iam.v1.IGetIamPolicyRequest
GetIamPolicyRequest message or plain object |
Type | Description |
Promise<google.iam.v1.Policy> | Promise |
getSnapshot(request, callback)
public getSnapshot(request: google.bigtable.admin.v2.IGetSnapshotRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshotCallback): void;
Calls GetSnapshot.
Name | Description |
request |
IGetSnapshotRequest
GetSnapshotRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshotCallback
Node-style callback called with the error, if any, and Snapshot |
Type | Description |
void |
getSnapshot(request)
public getSnapshot(request: google.bigtable.admin.v2.IGetSnapshotRequest): Promise<google.bigtable.admin.v2.Snapshot>;
Calls GetSnapshot.
Name | Description |
request |
IGetSnapshotRequest
GetSnapshotRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Snapshot> | Promise |
getTable(request, callback)
public getTable(request: google.bigtable.admin.v2.IGetTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.GetTableCallback): void;
Calls GetTable.
Name | Description |
request |
IGetTableRequest
GetTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.GetTableCallback
Node-style callback called with the error, if any, and Table |
Type | Description |
void |
getTable(request)
public getTable(request: google.bigtable.admin.v2.IGetTableRequest): Promise<google.bigtable.admin.v2.Table>;
Calls GetTable.
Name | Description |
request |
IGetTableRequest
GetTableRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Table> | Promise |
listBackups(request, callback)
public listBackups(request: google.bigtable.admin.v2.IListBackupsRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.ListBackupsCallback): void;
Calls ListBackups.
Name | Description |
request |
google.bigtable.admin.v2.IListBackupsRequest
ListBackupsRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.ListBackupsCallback
Node-style callback called with the error, if any, and ListBackupsResponse |
Type | Description |
void |
listBackups(request)
public listBackups(request: google.bigtable.admin.v2.IListBackupsRequest): Promise<google.bigtable.admin.v2.ListBackupsResponse>;
Calls ListBackups.
Name | Description |
request |
google.bigtable.admin.v2.IListBackupsRequest
ListBackupsRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.ListBackupsResponse> | Promise |
listSnapshots(request, callback)
public listSnapshots(request: google.bigtable.admin.v2.IListSnapshotsRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshotsCallback): void;
Calls ListSnapshots.
Name | Description |
request |
google.bigtable.admin.v2.IListSnapshotsRequest
ListSnapshotsRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshotsCallback
Node-style callback called with the error, if any, and ListSnapshotsResponse |
Type | Description |
void |
listSnapshots(request)
public listSnapshots(request: google.bigtable.admin.v2.IListSnapshotsRequest): Promise<google.bigtable.admin.v2.ListSnapshotsResponse>;
Calls ListSnapshots.
Name | Description |
request |
google.bigtable.admin.v2.IListSnapshotsRequest
ListSnapshotsRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.ListSnapshotsResponse> | Promise |
listTables(request, callback)
public listTables(request: google.bigtable.admin.v2.IListTablesRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.ListTablesCallback): void;
Calls ListTables.
Name | Description |
request |
google.bigtable.admin.v2.IListTablesRequest
ListTablesRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.ListTablesCallback
Node-style callback called with the error, if any, and ListTablesResponse |
Type | Description |
void |
listTables(request)
public listTables(request: google.bigtable.admin.v2.IListTablesRequest): Promise<google.bigtable.admin.v2.ListTablesResponse>;
Calls ListTables.
Name | Description |
request |
google.bigtable.admin.v2.IListTablesRequest
ListTablesRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.ListTablesResponse> | Promise |
modifyColumnFamilies(request, callback)
public modifyColumnFamilies(request: google.bigtable.admin.v2.IModifyColumnFamiliesRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamiliesCallback): void;
Calls ModifyColumnFamilies.
Name | Description |
request |
google.bigtable.admin.v2.IModifyColumnFamiliesRequest
ModifyColumnFamiliesRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamiliesCallback
Node-style callback called with the error, if any, and Table |
Type | Description |
void |
modifyColumnFamilies(request)
public modifyColumnFamilies(request: google.bigtable.admin.v2.IModifyColumnFamiliesRequest): Promise<google.bigtable.admin.v2.Table>;
Calls ModifyColumnFamilies.
Name | Description |
request |
google.bigtable.admin.v2.IModifyColumnFamiliesRequest
ModifyColumnFamiliesRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Table> | Promise |
restoreTable(request, callback)
public restoreTable(request: google.bigtable.admin.v2.IRestoreTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.RestoreTableCallback): void;
Calls RestoreTable.
Name | Description |
request |
IRestoreTableRequest
RestoreTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.RestoreTableCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
restoreTable(request)
public restoreTable(request: google.bigtable.admin.v2.IRestoreTableRequest): Promise<google.longrunning.Operation>;
Calls RestoreTable.
Name | Description |
request |
IRestoreTableRequest
RestoreTableRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
setIamPolicy(request, callback)
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.SetIamPolicyCallback): void;
Calls SetIamPolicy.
Name | Description |
request |
google.iam.v1.ISetIamPolicyRequest
SetIamPolicyRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.SetIamPolicyCallback
Node-style callback called with the error, if any, and Policy |
Type | Description |
void |
setIamPolicy(request)
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;
Calls SetIamPolicy.
Name | Description |
request |
google.iam.v1.ISetIamPolicyRequest
SetIamPolicyRequest message or plain object |
Type | Description |
Promise<google.iam.v1.Policy> | Promise |
snapshotTable(request, callback)
public snapshotTable(request: google.bigtable.admin.v2.ISnapshotTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTableCallback): void;
Calls SnapshotTable.
Name | Description |
request |
google.bigtable.admin.v2.ISnapshotTableRequest
SnapshotTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTableCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
snapshotTable(request)
public snapshotTable(request: google.bigtable.admin.v2.ISnapshotTableRequest): Promise<google.longrunning.Operation>;
Calls SnapshotTable.
Name | Description |
request |
google.bigtable.admin.v2.ISnapshotTableRequest
SnapshotTableRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
testIamPermissions(request, callback)
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.TestIamPermissionsCallback): void;
Calls TestIamPermissions.
Name | Description |
request |
google.iam.v1.ITestIamPermissionsRequest
TestIamPermissionsRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.TestIamPermissionsCallback
Node-style callback called with the error, if any, and TestIamPermissionsResponse |
Type | Description |
void |
testIamPermissions(request)
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;
Calls TestIamPermissions.
Name | Description |
request |
google.iam.v1.ITestIamPermissionsRequest
TestIamPermissionsRequest message or plain object |
Type | Description |
Promise<google.iam.v1.TestIamPermissionsResponse> | Promise |
undeleteTable(request, callback)
public undeleteTable(request: google.bigtable.admin.v2.IUndeleteTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTableCallback): void;
Calls UndeleteTable.
Name | Description |
request |
IUndeleteTableRequest
UndeleteTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTableCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
undeleteTable(request)
public undeleteTable(request: google.bigtable.admin.v2.IUndeleteTableRequest): Promise<google.longrunning.Operation>;
Calls UndeleteTable.
Name | Description |
request |
IUndeleteTableRequest
UndeleteTableRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |
updateBackup(request, callback)
public updateBackup(request: google.bigtable.admin.v2.IUpdateBackupRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackupCallback): void;
Calls UpdateBackup.
Name | Description |
request |
google.bigtable.admin.v2.IUpdateBackupRequest
UpdateBackupRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackupCallback
Node-style callback called with the error, if any, and Backup |
Type | Description |
void |
updateBackup(request)
public updateBackup(request: google.bigtable.admin.v2.IUpdateBackupRequest): Promise<google.bigtable.admin.v2.Backup>;
Calls UpdateBackup.
Name | Description |
request |
google.bigtable.admin.v2.IUpdateBackupRequest
UpdateBackupRequest message or plain object |
Type | Description |
Promise<google.bigtable.admin.v2.Backup> | Promise |
updateTable(request, callback)
public updateTable(request: google.bigtable.admin.v2.IUpdateTableRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.UpdateTableCallback): void;
Calls UpdateTable.
Name | Description |
request |
IUpdateTableRequest
UpdateTableRequest message or plain object |
callback |
google.bigtable.admin.v2.BigtableTableAdmin.UpdateTableCallback
Node-style callback called with the error, if any, and Operation |
Type | Description |
void |
updateTable(request)
public updateTable(request: google.bigtable.admin.v2.IUpdateTableRequest): Promise<google.longrunning.Operation>;
Calls UpdateTable.
Name | Description |
request |
IUpdateTableRequest
UpdateTableRequest message or plain object |
Type | Description |
Promise<google.longrunning.Operation> | Promise |