Class protos.google.bigtable.admin.v2.BigtableTableAdmin (5.0.0)

Version latest

• 5.0.0 (latest)
• 4.6.1
• 4.1.0
• 4.0.5
• 3.10.0
• 3.9.4
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.4

Represents a BigtableTableAdmin

Inheritance

$protobuf.rpc.Service > protos.google.bigtable.admin.v2.BigtableTableAdmin

Package

@google-cloud/bigtable

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BigtableTableAdmin service.

Parameters
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.

Parameters
Name	Description
request	ICheckConsistencyRequest CheckConsistencyRequest message or plain object
callback	CheckConsistencyCallback Node-style callback called with the error, if any, and CheckConsistencyResponse

Returns
Type	Description
void

checkConsistency(request)

public checkConsistency(request: google.bigtable.admin.v2.ICheckConsistencyRequest): Promise<google.bigtable.admin.v2.CheckConsistencyResponse>;

Calls CheckConsistency.

Parameter
Name	Description
request	ICheckConsistencyRequest CheckConsistencyRequest message or plain object

Returns
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.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
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.

Parameters
Name	Description
request	ICreateBackupRequest CreateBackupRequest message or plain object
callback	CreateBackupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createBackup(request)

public createBackup(request: google.bigtable.admin.v2.ICreateBackupRequest): Promise<google.longrunning.Operation>;

Calls CreateBackup.

Parameter
Name	Description
request	ICreateBackupRequest CreateBackupRequest message or plain object

Returns
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.

Parameters
Name	Description
request	ICreateTableRequest CreateTableRequest message or plain object
callback	CreateTableCallback Node-style callback called with the error, if any, and Table

Returns
Type	Description
void

createTable(request)

public createTable(request: google.bigtable.admin.v2.ICreateTableRequest): Promise<google.bigtable.admin.v2.Table>;

Calls CreateTable.

Parameter
Name	Description
request	ICreateTableRequest CreateTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	ICreateTableFromSnapshotRequest CreateTableFromSnapshotRequest message or plain object
callback	CreateTableFromSnapshotCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createTableFromSnapshot(request)

public createTableFromSnapshot(request: google.bigtable.admin.v2.ICreateTableFromSnapshotRequest): Promise<google.longrunning.Operation>;

Calls CreateTableFromSnapshot.

Parameter
Name	Description
request	ICreateTableFromSnapshotRequest CreateTableFromSnapshotRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IDeleteBackupRequest DeleteBackupRequest message or plain object
callback	DeleteBackupCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteBackup(request)

public deleteBackup(request: google.bigtable.admin.v2.IDeleteBackupRequest): Promise<google.protobuf.Empty>;

Calls DeleteBackup.

Parameter
Name	Description
request	IDeleteBackupRequest DeleteBackupRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IDeleteSnapshotRequest DeleteSnapshotRequest message or plain object
callback	DeleteSnapshotCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteSnapshot(request)

public deleteSnapshot(request: google.bigtable.admin.v2.IDeleteSnapshotRequest): Promise<google.protobuf.Empty>;

Calls DeleteSnapshot.

Parameter
Name	Description
request	IDeleteSnapshotRequest DeleteSnapshotRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IDeleteTableRequest DeleteTableRequest message or plain object
callback	DeleteTableCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteTable(request)

public deleteTable(request: google.bigtable.admin.v2.IDeleteTableRequest): Promise<google.protobuf.Empty>;

Calls DeleteTable.

Parameter
Name	Description
request	IDeleteTableRequest DeleteTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IDropRowRangeRequest DropRowRangeRequest message or plain object
callback	DropRowRangeCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

dropRowRange(request)

public dropRowRange(request: google.bigtable.admin.v2.IDropRowRangeRequest): Promise<google.protobuf.Empty>;

Calls DropRowRange.

Parameter
Name	Description
request	IDropRowRangeRequest DropRowRangeRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IGenerateConsistencyTokenRequest GenerateConsistencyTokenRequest message or plain object
callback	GenerateConsistencyTokenCallback Node-style callback called with the error, if any, and GenerateConsistencyTokenResponse

Returns
Type	Description
void

generateConsistencyToken(request)

public generateConsistencyToken(request: google.bigtable.admin.v2.IGenerateConsistencyTokenRequest): Promise<google.bigtable.admin.v2.GenerateConsistencyTokenResponse>;

Calls GenerateConsistencyToken.

Parameter
Name	Description
request	IGenerateConsistencyTokenRequest GenerateConsistencyTokenRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IGetBackupRequest GetBackupRequest message or plain object
callback	GetBackupCallback Node-style callback called with the error, if any, and Backup

Returns
Type	Description
void

getBackup(request)

public getBackup(request: google.bigtable.admin.v2.IGetBackupRequest): Promise<google.bigtable.admin.v2.Backup>;

Calls GetBackup.

Parameter
Name	Description
request	IGetBackupRequest GetBackupRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object
callback	GetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IGetSnapshotRequest GetSnapshotRequest message or plain object
callback	GetSnapshotCallback Node-style callback called with the error, if any, and Snapshot

Returns
Type	Description
void

getSnapshot(request)

public getSnapshot(request: google.bigtable.admin.v2.IGetSnapshotRequest): Promise<google.bigtable.admin.v2.Snapshot>;

Calls GetSnapshot.

Parameter
Name	Description
request	IGetSnapshotRequest GetSnapshotRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IGetTableRequest GetTableRequest message or plain object
callback	GetTableCallback Node-style callback called with the error, if any, and Table

Returns
Type	Description
void

getTable(request)

public getTable(request: google.bigtable.admin.v2.IGetTableRequest): Promise<google.bigtable.admin.v2.Table>;

Calls GetTable.

Parameter
Name	Description
request	IGetTableRequest GetTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IListBackupsRequest ListBackupsRequest message or plain object
callback	ListBackupsCallback Node-style callback called with the error, if any, and ListBackupsResponse

Returns
Type	Description
void

listBackups(request)

public listBackups(request: google.bigtable.admin.v2.IListBackupsRequest): Promise<google.bigtable.admin.v2.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name	Description
request	IListBackupsRequest ListBackupsRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IListSnapshotsRequest ListSnapshotsRequest message or plain object
callback	ListSnapshotsCallback Node-style callback called with the error, if any, and ListSnapshotsResponse

Returns
Type	Description
void

listSnapshots(request)

public listSnapshots(request: google.bigtable.admin.v2.IListSnapshotsRequest): Promise<google.bigtable.admin.v2.ListSnapshotsResponse>;

Calls ListSnapshots.

Parameter
Name	Description
request	IListSnapshotsRequest ListSnapshotsRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IListTablesRequest ListTablesRequest message or plain object
callback	ListTablesCallback Node-style callback called with the error, if any, and ListTablesResponse

Returns
Type	Description
void

listTables(request)

public listTables(request: google.bigtable.admin.v2.IListTablesRequest): Promise<google.bigtable.admin.v2.ListTablesResponse>;

Calls ListTables.

Parameter
Name	Description
request	IListTablesRequest ListTablesRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IModifyColumnFamiliesRequest ModifyColumnFamiliesRequest message or plain object
callback	ModifyColumnFamiliesCallback Node-style callback called with the error, if any, and Table

Returns
Type	Description
void

modifyColumnFamilies(request)

public modifyColumnFamilies(request: google.bigtable.admin.v2.IModifyColumnFamiliesRequest): Promise<google.bigtable.admin.v2.Table>;

Calls ModifyColumnFamilies.

Parameter
Name	Description
request	IModifyColumnFamiliesRequest ModifyColumnFamiliesRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IRestoreTableRequest RestoreTableRequest message or plain object
callback	RestoreTableCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

restoreTable(request)

public restoreTable(request: google.bigtable.admin.v2.IRestoreTableRequest): Promise<google.longrunning.Operation>;

Calls RestoreTable.

Parameter
Name	Description
request	IRestoreTableRequest RestoreTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object
callback	SetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object

Returns
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.

Parameters
Name	Description
request	ISnapshotTableRequest SnapshotTableRequest message or plain object
callback	SnapshotTableCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

snapshotTable(request)

public snapshotTable(request: google.bigtable.admin.v2.ISnapshotTableRequest): Promise<google.longrunning.Operation>;

Calls SnapshotTable.

Parameter
Name	Description
request	ISnapshotTableRequest SnapshotTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object
callback	TestIamPermissionsCallback Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns
Type	Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name	Description
request	ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IUndeleteTableRequest UndeleteTableRequest message or plain object
callback	UndeleteTableCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

undeleteTable(request)

public undeleteTable(request: google.bigtable.admin.v2.IUndeleteTableRequest): Promise<google.longrunning.Operation>;

Calls UndeleteTable.

Parameter
Name	Description
request	IUndeleteTableRequest UndeleteTableRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IUpdateBackupRequest UpdateBackupRequest message or plain object
callback	UpdateBackupCallback Node-style callback called with the error, if any, and Backup

Returns
Type	Description
void

updateBackup(request)

public updateBackup(request: google.bigtable.admin.v2.IUpdateBackupRequest): Promise<google.bigtable.admin.v2.Backup>;

Calls UpdateBackup.

Parameter
Name	Description
request	IUpdateBackupRequest UpdateBackupRequest message or plain object

Returns
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.

Parameters
Name	Description
request	IUpdateTableRequest UpdateTableRequest message or plain object
callback	UpdateTableCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateTable(request)

public updateTable(request: google.bigtable.admin.v2.IUpdateTableRequest): Promise<google.longrunning.Operation>;

Calls UpdateTable.

Parameter
Name	Description
request	IUpdateTableRequest UpdateTableRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise