BigtableTableAdmin

google.bigtable.admin.v2. BigtableTableAdmin

Represents a BigtableTableAdmin

Constructor

new BigtableTableAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new BigtableTableAdmin service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {BigtableTableAdmin}

Creates new BigtableTableAdmin service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
BigtableTableAdmin

RPC service. Useful where requests and/or responses are streamed.

checkConsistency(request, callback) → {undefined}

Calls CheckConsistency.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

checkConsistency(request) → {Promise.<google.bigtable.admin.v2.CheckConsistencyResponse>}

Calls CheckConsistency.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICheckConsistencyRequest

CheckConsistencyRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.CheckConsistencyResponse>

Promise

createBackup(request, callback) → {undefined}

Calls CreateBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

createBackup(request) → {Promise.<google.longrunning.Operation>}

Calls CreateBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateBackupRequest

CreateBackupRequest message or plain object

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

Promise

createTable(request, callback) → {undefined}

Calls CreateTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

createTable(request) → {Promise.<google.bigtable.admin.v2.Table>}

Calls CreateTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateTableRequest

CreateTableRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Table>

Promise

createTableFromSnapshot(request, callback) → {undefined}

Calls CreateTableFromSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

createTableFromSnapshot(request) → {Promise.<google.longrunning.Operation>}

Calls CreateTableFromSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ICreateTableFromSnapshotRequest

CreateTableFromSnapshotRequest message or plain object

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

Promise

deleteBackup(request, callback) → {undefined}

Calls DeleteBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

deleteBackup(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteBackupRequest

DeleteBackupRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteSnapshot(request, callback) → {undefined}

Calls DeleteSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

deleteSnapshot(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteSnapshotRequest

DeleteSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteTable(request, callback) → {undefined}

Calls DeleteTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

deleteTable(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDeleteTableRequest

DeleteTableRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

dropRowRange(request, callback) → {undefined}

Calls DropRowRange.

Parameters:
Name Type Description
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:
Type Description
undefined

dropRowRange(request) → {Promise.<google.protobuf.Empty>}

Calls DropRowRange.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IDropRowRangeRequest

DropRowRangeRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

generateConsistencyToken(request, callback) → {undefined}

Calls GenerateConsistencyToken.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

generateConsistencyToken(request) → {Promise.<google.bigtable.admin.v2.GenerateConsistencyTokenResponse>}

Calls GenerateConsistencyToken.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGenerateConsistencyTokenRequest

GenerateConsistencyTokenRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.GenerateConsistencyTokenResponse>

Promise

getBackup(request, callback) → {undefined}

Calls GetBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

getBackup(request) → {Promise.<google.bigtable.admin.v2.Backup>}

Calls GetBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGetBackupRequest

GetBackupRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Backup>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type 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

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

getSnapshot(request, callback) → {undefined}

Calls GetSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

getSnapshot(request) → {Promise.<google.bigtable.admin.v2.Snapshot>}

Calls GetSnapshot.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGetSnapshotRequest

GetSnapshotRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Snapshot>

Promise

getTable(request, callback) → {undefined}

Calls GetTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

getTable(request) → {Promise.<google.bigtable.admin.v2.Table>}

Calls GetTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IGetTableRequest

GetTableRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Table>

Promise

listBackups(request, callback) → {undefined}

Calls ListBackups.

Parameters:
Name Type 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

Returns:
Type Description
undefined

listBackups(request) → {Promise.<google.bigtable.admin.v2.ListBackupsResponse>}

Calls ListBackups.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IListBackupsRequest

ListBackupsRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.ListBackupsResponse>

Promise

listSnapshots(request, callback) → {undefined}

Calls ListSnapshots.

Parameters:
Name Type 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

Returns:
Type Description
undefined

listSnapshots(request) → {Promise.<google.bigtable.admin.v2.ListSnapshotsResponse>}

Calls ListSnapshots.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IListSnapshotsRequest

ListSnapshotsRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.ListSnapshotsResponse>

Promise

listTables(request, callback) → {undefined}

Calls ListTables.

Parameters:
Name Type 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

Returns:
Type Description
undefined

listTables(request) → {Promise.<google.bigtable.admin.v2.ListTablesResponse>}

Calls ListTables.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IListTablesRequest

ListTablesRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.ListTablesResponse>

Promise

modifyColumnFamilies(request, callback) → {undefined}

Calls ModifyColumnFamilies.

Parameters:
Name Type 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

Returns:
Type Description
undefined

modifyColumnFamilies(request) → {Promise.<google.bigtable.admin.v2.Table>}

Calls ModifyColumnFamilies.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IModifyColumnFamiliesRequest

ModifyColumnFamiliesRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Table>

Promise

restoreTable(request, callback) → {undefined}

Calls RestoreTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.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:
Type Description
undefined

restoreTable(request) → {Promise.<google.longrunning.Operation>}

Calls RestoreTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IRestoreTableRequest

RestoreTableRequest message or plain object

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

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type 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

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

snapshotTable(request, callback) → {undefined}

Calls SnapshotTable.

Parameters:
Name Type 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

Returns:
Type Description
undefined

snapshotTable(request) → {Promise.<google.longrunning.Operation>}

Calls SnapshotTable.

Parameters:
Name Type Description
request google.bigtable.admin.v2.ISnapshotTableRequest

SnapshotTableRequest message or plain object

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

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type 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

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.TestIamPermissionsResponse>

Promise

updateBackup(request, callback) → {undefined}

Calls UpdateBackup.

Parameters:
Name Type 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

Returns:
Type Description
undefined

updateBackup(request) → {Promise.<google.bigtable.admin.v2.Backup>}

Calls UpdateBackup.

Parameters:
Name Type Description
request google.bigtable.admin.v2.IUpdateBackupRequest

UpdateBackupRequest message or plain object

Returns:
Type Description
Promise.<google.bigtable.admin.v2.Backup>

Promise

Type Definitions

CheckConsistencyCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#checkConsistency.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.CheckConsistencyResponse <optional>

CheckConsistencyResponse

CreateBackupCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#createBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

CreateTableCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#createTable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Table <optional>

Table

CreateTableFromSnapshotCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#createTableFromSnapshot.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteBackupCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#deleteBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteSnapshotCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#deleteSnapshot.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DeleteTableCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#deleteTable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

DropRowRangeCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#dropRowRange.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GenerateConsistencyTokenCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#generateConsistencyToken.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.GenerateConsistencyTokenResponse <optional>

GenerateConsistencyTokenResponse

GetBackupCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#getBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Backup <optional>

Backup

GetIamPolicyCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

GetSnapshotCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#getSnapshot.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Snapshot <optional>

Snapshot

GetTableCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#getTable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Table <optional>

Table

ListBackupsCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#listBackups.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListBackupsResponse <optional>

ListBackupsResponse

ListSnapshotsCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#listSnapshots.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListSnapshotsResponse <optional>

ListSnapshotsResponse

ListTablesCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#listTables.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.ListTablesResponse <optional>

ListTablesResponse

ModifyColumnFamiliesCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#modifyColumnFamilies.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Table <optional>

Table

RestoreTableCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#restoreTable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

SetIamPolicyCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

SnapshotTableCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#snapshotTable.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

TestIamPermissionsCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UpdateBackupCallback(error, responseopt)

Callback as used by google.bigtable.admin.v2.BigtableTableAdmin#updateBackup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.bigtable.admin.v2.Backup <optional>

Backup