Service for creating, configuring, and deleting Cloud Bigtable tables.
Provides access to the table schemas only, not the data stored within the tables. v2
Package
@google-cloud/bigtable!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of BigtableTableAdminClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
bigtableTableAdminStub
bigtableTableAdminStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
Methods
appProfilePath(project, instance, appProfile)
appProfilePath
(
project
:
string
,
instance
:
string
,
appProfile
:
string
)
:
string
;
Return a fully-qualified appProfile resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
backupPath(project, instance, cluster, backup)
backupPath
(
project
:
string
,
instance
:
string
,
cluster
:
string
,
backup
:
string
)
:
string
;
Return a fully-qualified backup resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
checkConsistency(request, options)
checkConsistency
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyResponse
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICheckConsistencyRequest
|
options |
CallOptions
|
Returns
checkConsistency(request, options, callback)
checkConsistency
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyResponse
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICheckConsistencyRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.ICheckConsistencyResponse
, protos. google.bigtable.admin.v2.ICheckConsistencyRequest
| null | undefined, {} | null | undefined>
|
Returns
checkConsistency(request, callback)
checkConsistency
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyResponse
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICheckConsistencyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICheckConsistencyRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.ICheckConsistencyResponse
, protos. google.bigtable.admin.v2.ICheckConsistencyRequest
| null | undefined, {} | null | undefined>
|
Returns
checkCreateBackupProgress(name)
checkCreateBackupProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
Backup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
CreateBackupMetadata
>> ;
Check the status of the long running operation returned by createBackup()
.
Parameter Name |
Description |
name |
string
The operation name that will be passed.
|
Returns Type |
Description |
Promise
< LROperation
<protos. google.bigtable.admin.v2.Backup
, protos. google.bigtable.admin.v2.CreateBackupMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkCreateTableFromSnapshotProgress(name)
checkCreateTableFromSnapshotProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
Table
,
protos
.
google
.
bigtable
.
admin
.
v2
.
CreateTableFromSnapshotMetadata
>> ;
Check the status of the long running operation returned by createTableFromSnapshot()
.
Parameter Name |
Description |
name |
string
The operation name that will be passed.
|
Returns Type |
Description |
Promise
< LROperation
<protos. google.bigtable.admin.v2.Table
, protos. google.bigtable.admin.v2.CreateTableFromSnapshotMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkRestoreTableProgress(name)
checkRestoreTableProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
Table
,
protos
.
google
.
bigtable
.
admin
.
v2
.
RestoreTableMetadata
>> ;
Check the status of the long running operation returned by restoreTable()
.
Parameter Name |
Description |
name |
string
The operation name that will be passed.
|
Returns Type |
Description |
Promise
< LROperation
<protos. google.bigtable.admin.v2.Table
, protos. google.bigtable.admin.v2.RestoreTableMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
checkSnapshotTableProgress(name)
checkSnapshotTableProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
Snapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
SnapshotTableMetadata
>> ;
Check the status of the long running operation returned by snapshotTable()
.
Parameter Name |
Description |
name |
string
The operation name that will be passed.
|
Returns Type |
Description |
Promise
< LROperation
<protos. google.bigtable.admin.v2.Snapshot
, protos. google.bigtable.admin.v2.SnapshotTableMetadata
>> |
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type |
Description |
Promise
<void> |
{Promise} A promise that resolves when the client is closed.
|
clusterPath(project, instance, cluster)
clusterPath
(
project
:
string
,
instance
:
string
,
cluster
:
string
)
:
string
;
Return a fully-qualified cluster resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
createBackup(request, options)
createBackup
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateBackupRequest
|
options |
CallOptions
|
Returns
createBackup(request, options, callback)
createBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateBackupRequest
|
options |
CallOptions
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.ICreateBackupMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
createBackup(request, callback)
createBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupRequest
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateBackupMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateBackupRequest
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.ICreateBackupMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
createTable(request, options)
createTable
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableRequest
|
options |
CallOptions
|
Returns
createTable(request, options, callback)
createTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.ICreateTableRequest
| null | undefined, {} | null | undefined>
|
Returns
createTable(request, callback)
createTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.ICreateTableRequest
| null | undefined, {} | null | undefined>
|
Returns
createTableFromSnapshot(request, options)
createTableFromSnapshot
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableFromSnapshotRequest
|
options |
CallOptions
|
Returns
createTableFromSnapshot(request, options, callback)
createTableFromSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableFromSnapshotRequest
|
options |
CallOptions
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.ICreateTableFromSnapshotMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
createTableFromSnapshot(request, callback)
createTableFromSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotRequest
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ICreateTableFromSnapshotMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ICreateTableFromSnapshotRequest
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.ICreateTableFromSnapshotMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
deleteBackup(request, options)
deleteBackup
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteBackupRequest
|
options |
CallOptions
|
Returns
deleteBackup(request, options, callback)
deleteBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteBackupRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteBackupRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteBackup(request, callback)
deleteBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteBackupRequest
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteBackupRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteSnapshot(request, options)
deleteSnapshot
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteSnapshotRequest
|
options |
CallOptions
|
Returns
deleteSnapshot(request, options, callback)
deleteSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteSnapshotRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteSnapshotRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteSnapshot(request, callback)
deleteSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteSnapshotRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteSnapshotRequest
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteSnapshotRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteTable(request, options)
deleteTable
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteTableRequest
|
options |
CallOptions
|
Returns
deleteTable(request, options, callback)
deleteTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteTableRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteTableRequest
| null | undefined, {} | null | undefined>
|
Returns
deleteTable(request, callback)
deleteTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDeleteTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDeleteTableRequest
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDeleteTableRequest
| null | undefined, {} | null | undefined>
|
Returns
dropRowRange(request, options)
dropRowRange
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDropRowRangeRequest
|
options |
CallOptions
|
Returns
dropRowRange(request, options, callback)
dropRowRange
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDropRowRangeRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDropRowRangeRequest
| null | undefined, {} | null | undefined>
|
Returns
dropRowRange(request, callback)
dropRowRange
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IDropRowRangeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IDropRowRangeRequest
|
callback |
Callback
<protos. google.protobuf.IEmpty
, protos. google.bigtable.admin.v2.IDropRowRangeRequest
| null | undefined, {} | null | undefined>
|
Returns
generateConsistencyToken(request, options)
generateConsistencyToken
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenResponse
,
(
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGenerateConsistencyTokenRequest
|
options |
CallOptions
|
Returns
generateConsistencyToken(request, options, callback)
generateConsistencyToken
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenResponse
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGenerateConsistencyTokenRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.IGenerateConsistencyTokenResponse
, protos. google.bigtable.admin.v2.IGenerateConsistencyTokenRequest
| null | undefined, {} | null | undefined>
|
Returns
generateConsistencyToken(request, callback)
generateConsistencyToken
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenResponse
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGenerateConsistencyTokenRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGenerateConsistencyTokenRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.IGenerateConsistencyTokenResponse
, protos. google.bigtable.admin.v2.IGenerateConsistencyTokenRequest
| null | undefined, {} | null | undefined>
|
Returns
getBackup(request, options)
getBackup
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetBackupRequest
|
options |
CallOptions
|
Returns
getBackup(request, options, callback)
getBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetBackupRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.IGetBackupRequest
| null | undefined, {} | null | undefined>
|
Returns
getBackup(request, callback)
getBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetBackupRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.IGetBackupRequest
| null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, options)
getIamPolicy
(
request
?:
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
Returns
getIamPolicy(request, options, callback)
getIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.IGetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.IGetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
Returns
getIamPolicy(request, callback)
getIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
IGetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.IGetIamPolicyRequest
|
callback |
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.IGetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name |
Description |
callback |
Callback
<string, undefined, undefined>
|
Returns
getSnapshot(request, options)
getSnapshot
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetSnapshotRequest
|
options |
CallOptions
|
Returns
getSnapshot(request, options, callback)
getSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetSnapshotRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.ISnapshot
, protos. google.bigtable.admin.v2.IGetSnapshotRequest
| null | undefined, {} | null | undefined>
|
Returns
getSnapshot(request, callback)
getSnapshot
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetSnapshotRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetSnapshotRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.ISnapshot
, protos. google.bigtable.admin.v2.IGetSnapshotRequest
| null | undefined, {} | null | undefined>
|
Returns
getTable(request, options)
getTable
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetTableRequest
|
options |
CallOptions
|
Returns
getTable(request, options, callback)
getTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetTableRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IGetTableRequest
| null | undefined, {} | null | undefined>
|
Returns
getTable(request, callback)
getTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IGetTableRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IGetTableRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IGetTableRequest
| null | undefined, {} | null | undefined>
|
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type |
Description |
Promise
<{
[name: string]: Function
;
}> |
{Promise} A promise that resolves to an authenticated service stub.
|
instancePath(project, instance)
instancePath
(
project
:
string
,
instance
:
string
)
:
string
;
Return a fully-qualified instance resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
listBackups(request, options)
listBackups
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
[],
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
|
null
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsResponse
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListBackupsRequest
|
options |
CallOptions
|
Returns
listBackups(request, options, callback)
listBackups
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListBackupsRequest
|
options |
CallOptions
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListBackupsRequest
, protos. google.bigtable.admin.v2.IListBackupsResponse
| null | undefined, protos. google.bigtable.admin.v2.IBackup
>
|
Returns
listBackups(request, callback)
listBackups
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListBackupsRequest
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListBackupsRequest
, protos. google.bigtable.admin.v2.IListBackupsResponse
| null | undefined, protos. google.bigtable.admin.v2.IBackup
>
|
Returns
listBackupsAsync(request, options)
listBackupsAsync
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
> ;
Equivalent to listBackups
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListBackupsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
AsyncIterable
<protos. google.bigtable.admin.v2.IBackup
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Backup]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listBackupsStream(request, options)
listBackupsStream
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListBackupsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListBackupsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
Transform
|
{Stream} An object stream which emits an object representing [Backup] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBackupsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSnapshots(request, options)
listSnapshots
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
[],
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
|
null
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsResponse
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListSnapshotsRequest
|
options |
CallOptions
|
Returns
listSnapshots(request, options, callback)
listSnapshots
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListSnapshotsRequest
|
options |
CallOptions
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListSnapshotsRequest
, protos. google.bigtable.admin.v2.IListSnapshotsResponse
| null | undefined, protos. google.bigtable.admin.v2.ISnapshot
>
|
Returns
listSnapshots(request, callback)
listSnapshots
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListSnapshotsRequest
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListSnapshotsRequest
, protos. google.bigtable.admin.v2.IListSnapshotsResponse
| null | undefined, protos. google.bigtable.admin.v2.ISnapshot
>
|
Returns
listSnapshotsAsync(request, options)
listSnapshotsAsync
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
> ;
Equivalent to listSnapshots
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListSnapshotsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
AsyncIterable
<protos. google.bigtable.admin.v2.ISnapshot
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Snapshot]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listSnapshotsStream(request, options)
listSnapshotsStream
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListSnapshotsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListSnapshotsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
Transform
|
{Stream} An object stream which emits an object representing [Snapshot] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSnapshotsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTables(request, options)
listTables
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
[],
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
|
null
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesResponse
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListTablesRequest
|
options |
CallOptions
|
Returns
listTables(request, options, callback)
listTables
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListTablesRequest
|
options |
CallOptions
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListTablesRequest
, protos. google.bigtable.admin.v2.IListTablesResponse
| null | undefined, protos. google.bigtable.admin.v2.ITable
>
|
Returns
listTables(request, callback)
listTables
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
callback
:
PaginationCallback<protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesResponse
|
null
|
undefined
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListTablesRequest
|
callback |
PaginationCallback
<protos. google.bigtable.admin.v2.IListTablesRequest
, protos. google.bigtable.admin.v2.IListTablesResponse
| null | undefined, protos. google.bigtable.admin.v2.ITable
>
|
Returns
listTablesAsync(request, options)
listTablesAsync
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
> ;
Equivalent to listTables
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListTablesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
AsyncIterable
<protos. google.bigtable.admin.v2.ITable
> |
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Table]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listTablesStream(request, options)
listTablesStream
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IListTablesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IListTablesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions
for more details.
|
Returns Type |
Description |
Transform
|
{Stream} An object stream which emits an object representing [Table] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listTablesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
matchAppProfileFromAppProfileName(appProfileName)
matchAppProfileFromAppProfileName
(
appProfileName
:
string
)
:
string
|
number
;
Parse the app_profile from AppProfile resource.
Parameter Name |
Description |
appProfileName |
string
A fully-qualified path representing AppProfile resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the app_profile.
|
matchBackupFromBackupName(backupName)
matchBackupFromBackupName
(
backupName
:
string
)
:
string
|
number
;
Parse the backup from Backup resource.
Parameter Name |
Description |
backupName |
string
A fully-qualified path representing Backup resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the backup.
|
matchClusterFromBackupName(backupName)
matchClusterFromBackupName
(
backupName
:
string
)
:
string
|
number
;
Parse the cluster from Backup resource.
Parameter Name |
Description |
backupName |
string
A fully-qualified path representing Backup resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the cluster.
|
matchClusterFromClusterName(clusterName)
matchClusterFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the cluster from Cluster resource.
Parameter Name |
Description |
clusterName |
string
A fully-qualified path representing Cluster resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the cluster.
|
matchClusterFromSnapshotName(snapshotName)
matchClusterFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the cluster from Snapshot resource.
Parameter Name |
Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the cluster.
|
matchInstanceFromAppProfileName(appProfileName)
matchInstanceFromAppProfileName
(
appProfileName
:
string
)
:
string
|
number
;
Parse the instance from AppProfile resource.
Parameter Name |
Description |
appProfileName |
string
A fully-qualified path representing AppProfile resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchInstanceFromBackupName(backupName)
matchInstanceFromBackupName
(
backupName
:
string
)
:
string
|
number
;
Parse the instance from Backup resource.
Parameter Name |
Description |
backupName |
string
A fully-qualified path representing Backup resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchInstanceFromClusterName(clusterName)
matchInstanceFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the instance from Cluster resource.
Parameter Name |
Description |
clusterName |
string
A fully-qualified path representing Cluster resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchInstanceFromInstanceName(instanceName)
matchInstanceFromInstanceName
(
instanceName
:
string
)
:
string
|
number
;
Parse the instance from Instance resource.
Parameter Name |
Description |
instanceName |
string
A fully-qualified path representing Instance resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchInstanceFromSnapshotName(snapshotName)
matchInstanceFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the instance from Snapshot resource.
Parameter Name |
Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchInstanceFromTableName(tableName)
matchInstanceFromTableName
(
tableName
:
string
)
:
string
|
number
;
Parse the instance from Table resource.
Parameter Name |
Description |
tableName |
string
A fully-qualified path representing Table resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the instance.
|
matchProjectFromAppProfileName(appProfileName)
matchProjectFromAppProfileName
(
appProfileName
:
string
)
:
string
|
number
;
Parse the project from AppProfile resource.
Parameter Name |
Description |
appProfileName |
string
A fully-qualified path representing AppProfile resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchProjectFromBackupName(backupName)
matchProjectFromBackupName
(
backupName
:
string
)
:
string
|
number
;
Parse the project from Backup resource.
Parameter Name |
Description |
backupName |
string
A fully-qualified path representing Backup resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchProjectFromClusterName(clusterName)
matchProjectFromClusterName
(
clusterName
:
string
)
:
string
|
number
;
Parse the project from Cluster resource.
Parameter Name |
Description |
clusterName |
string
A fully-qualified path representing Cluster resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchProjectFromInstanceName(instanceName)
matchProjectFromInstanceName
(
instanceName
:
string
)
:
string
|
number
;
Parse the project from Instance resource.
Parameter Name |
Description |
instanceName |
string
A fully-qualified path representing Instance resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchProjectFromSnapshotName(snapshotName)
matchProjectFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the project from Snapshot resource.
Parameter Name |
Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchProjectFromTableName(tableName)
matchProjectFromTableName
(
tableName
:
string
)
:
string
|
number
;
Parse the project from Table resource.
Parameter Name |
Description |
tableName |
string
A fully-qualified path representing Table resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the project.
|
matchSnapshotFromSnapshotName(snapshotName)
matchSnapshotFromSnapshotName
(
snapshotName
:
string
)
:
string
|
number
;
Parse the snapshot from Snapshot resource.
Parameter Name |
Description |
snapshotName |
string
A fully-qualified path representing Snapshot resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the snapshot.
|
matchTableFromTableName(tableName)
matchTableFromTableName
(
tableName
:
string
)
:
string
|
number
;
Parse the table from Table resource.
Parameter Name |
Description |
tableName |
string
A fully-qualified path representing Table resource.
|
Returns Type |
Description |
string | number
|
{string} A string representing the table.
|
modifyColumnFamilies(request, options)
modifyColumnFamilies
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IModifyColumnFamiliesRequest
|
options |
CallOptions
|
Returns
modifyColumnFamilies(request, options, callback)
modifyColumnFamilies
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IModifyColumnFamiliesRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IModifyColumnFamiliesRequest
| null | undefined, {} | null | undefined>
|
Returns
modifyColumnFamilies(request, callback)
modifyColumnFamilies
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IModifyColumnFamiliesRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IModifyColumnFamiliesRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IModifyColumnFamiliesRequest
| null | undefined, {} | null | undefined>
|
Returns
restoreTable(request, options)
restoreTable
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IRestoreTableRequest
|
options |
CallOptions
|
Returns
restoreTable(request, options, callback)
restoreTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IRestoreTableRequest
|
options |
CallOptions
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IRestoreTableMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
restoreTable(request, callback)
restoreTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableRequest
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ITable
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IRestoreTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IRestoreTableRequest
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ITable
, protos. google.bigtable.admin.v2.IRestoreTableMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, options)
setIamPolicy
(
request
?:
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
Returns
setIamPolicy(request, options, callback)
setIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.ISetIamPolicyRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.ISetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
Returns
setIamPolicy(request, callback)
setIamPolicy
(
request
:
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
IPolicy
,
protos
.
google
.
iam
.
v1
.
ISetIamPolicyRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.ISetIamPolicyRequest
|
callback |
Callback
<protos. google.iam.v1.IPolicy
, protos. google.iam.v1.ISetIamPolicyRequest
| null | undefined, {} | null | undefined>
|
Returns
snapshotPath(project, instance, cluster, snapshot)
snapshotPath
(
project
:
string
,
instance
:
string
,
cluster
:
string
,
snapshot
:
string
)
:
string
;
Return a fully-qualified snapshot resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
snapshotTable(request, options)
snapshotTable
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ISnapshotTableRequest
|
options |
CallOptions
|
Returns
snapshotTable(request, options, callback)
snapshotTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ISnapshotTableRequest
|
options |
CallOptions
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ISnapshot
, protos. google.bigtable.admin.v2.ISnapshotTableMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
snapshotTable(request, callback)
snapshotTable
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableRequest
,
callback
:
Callback<LROperation<protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshot
,
protos
.
google
.
bigtable
.
admin
.
v2
.
ISnapshotTableMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.ISnapshotTableRequest
|
callback |
Callback
< LROperation
<protos. google.bigtable.admin.v2.ISnapshot
, protos. google.bigtable.admin.v2.ISnapshotTableMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
|
Returns
tablePath(project, instance, table)
tablePath
(
project
:
string
,
instance
:
string
,
table
:
string
)
:
string
;
Return a fully-qualified table resource name string.
Parameters
Returns Type |
Description |
string
|
{string} Resource name string.
|
testIamPermissions(request, options)
testIamPermissions
(
request
?:
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsResponse
,
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
Returns
testIamPermissions(request, options, callback)
testIamPermissions
(
request
:
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
ITestIamPermissionsResponse
,
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.ITestIamPermissionsRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.iam.v1.ITestIamPermissionsResponse
, protos. google.iam.v1.ITestIamPermissionsRequest
| null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions
(
request
:
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
,
callback
:
Callback<protos
.
google
.
iam
.
v1
.
ITestIamPermissionsResponse
,
protos
.
google
.
iam
.
v1
.
ITestIamPermissionsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.iam.v1.ITestIamPermissionsRequest
|
callback |
Callback
<protos. google.iam.v1.ITestIamPermissionsResponse
, protos. google.iam.v1.ITestIamPermissionsRequest
| null | undefined, {} | null | undefined>
|
Returns
updateBackup(request, options)
updateBackup
(
request
?:
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IUpdateBackupRequest
|
options |
CallOptions
|
Returns
updateBackup(request, options, callback)
updateBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IUpdateBackupRequest
|
options |
CallOptions
|
callback |
Callback
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.IUpdateBackupRequest
| null | undefined, {} | null | undefined>
|
Returns
updateBackup(request, callback)
updateBackup
(
request
:
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
,
callback
:
Callback<protos
.
google
.
bigtable
.
admin
.
v2
.
IBackup
,
protos
.
google
.
bigtable
.
admin
.
v2
.
IUpdateBackupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name |
Description |
request |
protos. google.bigtable.admin.v2.IUpdateBackupRequest
|
callback |
Callback
<protos. google.bigtable.admin.v2.IBackup
, protos. google.bigtable.admin.v2.IUpdateBackupRequest
| null | undefined, {} | null | undefined>
|
Returns