Class protos.google.bigtable.admin.v2.BigtableTableAdmin (3.9.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
NameDescription
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
NameDescription
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

Returns
TypeDescription
void

checkConsistency(request)

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

Calls CheckConsistency.

Parameter
NameDescription
request ICheckConsistencyRequest

CheckConsistencyRequest message or plain object

Returns
TypeDescription
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
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

createBackup(request)

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

Calls CreateBackup.

Parameter
NameDescription
request ICreateBackupRequest

CreateBackupRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

createTable(request)

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

Calls CreateTable.

Parameter
NameDescription
request ICreateTableRequest

CreateTableRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

createTableFromSnapshot(request)

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

Calls CreateTableFromSnapshot.

Parameter
NameDescription
request ICreateTableFromSnapshotRequest

CreateTableFromSnapshotRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

deleteBackup(request)

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

Calls DeleteBackup.

Parameter
NameDescription
request IDeleteBackupRequest

DeleteBackupRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

deleteSnapshot(request)

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

Calls DeleteSnapshot.

Parameter
NameDescription
request IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

deleteTable(request)

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

Calls DeleteTable.

Parameter
NameDescription
request IDeleteTableRequest

DeleteTableRequest message or plain object

Returns
TypeDescription
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
NameDescription
request google.bigtable.admin.v2.IDropRowRangeRequest

DropRowRangeRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.DropRowRangeCallback

Node-style callback called with the error, if any, and Empty

Returns
TypeDescription
void

dropRowRange(request)

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

Calls DropRowRange.

Parameter
NameDescription
request google.bigtable.admin.v2.IDropRowRangeRequest

DropRowRangeRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

generateConsistencyToken(request)

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

Calls GenerateConsistencyToken.

Parameter
NameDescription
request IGenerateConsistencyTokenRequest

GenerateConsistencyTokenRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

getBackup(request)

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

Calls GetBackup.

Parameter
NameDescription
request IGetBackupRequest

GetBackupRequest message or plain object

Returns
TypeDescription
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
NameDescription
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns
TypeDescription
void

getIamPolicy(request)

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

Calls GetIamPolicy.

Parameter
NameDescription
request IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

getSnapshot(request)

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

Calls GetSnapshot.

Parameter
NameDescription
request IGetSnapshotRequest

GetSnapshotRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

getTable(request)

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

Calls GetTable.

Parameter
NameDescription
request IGetTableRequest

GetTableRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

listBackups(request)

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

Calls ListBackups.

Parameter
NameDescription
request google.bigtable.admin.v2.IListBackupsRequest

ListBackupsRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

listSnapshots(request)

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

Calls ListSnapshots.

Parameter
NameDescription
request google.bigtable.admin.v2.IListSnapshotsRequest

ListSnapshotsRequest message or plain object

Returns
TypeDescription
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
NameDescription
request IListTablesRequest

ListTablesRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.ListTablesCallback

Node-style callback called with the error, if any, and ListTablesResponse

Returns
TypeDescription
void

listTables(request)

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

Calls ListTables.

Parameter
NameDescription
request IListTablesRequest

ListTablesRequest message or plain object

Returns
TypeDescription
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
NameDescription
request IModifyColumnFamiliesRequest

ModifyColumnFamiliesRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamiliesCallback

Node-style callback called with the error, if any, and Table

Returns
TypeDescription
void

modifyColumnFamilies(request)

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

Calls ModifyColumnFamilies.

Parameter
NameDescription
request IModifyColumnFamiliesRequest

ModifyColumnFamiliesRequest message or plain object

Returns
TypeDescription
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
NameDescription
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

Returns
TypeDescription
void

restoreTable(request)

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

Calls RestoreTable.

Parameter
NameDescription
request IRestoreTableRequest

RestoreTableRequest message or plain object

Returns
TypeDescription
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
NameDescription
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns
TypeDescription
void

setIamPolicy(request)

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

Calls SetIamPolicy.

Parameter
NameDescription
request ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns
TypeDescription
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
NameDescription
request ISnapshotTableRequest

SnapshotTableRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTableCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

snapshotTable(request)

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

Calls SnapshotTable.

Parameter
NameDescription
request ISnapshotTableRequest

SnapshotTableRequest message or plain object

Returns
TypeDescription
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
NameDescription
request ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

callback google.bigtable.admin.v2.BigtableTableAdmin.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns
TypeDescription
void

testIamPermissions(request)

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

Calls TestIamPermissions.

Parameter
NameDescription
request ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns
TypeDescription
Promise<google.iam.v1.TestIamPermissionsResponse>

Promise

updateBackup(request, callback)

public updateBackup(request: google.bigtable.admin.v2.IUpdateBackupRequest, callback: google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackupCallback): void;

Calls UpdateBackup.

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

Returns
TypeDescription
void

updateBackup(request)

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

Calls UpdateBackup.

Parameter
NameDescription
request google.bigtable.admin.v2.IUpdateBackupRequest

UpdateBackupRequest message or plain object

Returns
TypeDescription
Promise<google.bigtable.admin.v2.Backup>

Promise