Interact with backups like get detailed information from BigTable, create a backup, or restore a backup to a table.
Package
@google-cloud/bigtableExample
const
{
Bigtable
}
=
require
(
' @google-cloud/bigtable
'
);
const
bigtable
=
new
Bigtable
();
const
instance
=
bigtable
.
instance
(
'my-instance'
);
const
cluster
=
instance
.
cluster
(
'my-cluster'
);
const
backup
=
cluster
.
backup
(
'my-backup'
);
Constructors
(constructor)(cluster, id)
constructor
(
cluster
:
Cluster
,
id
:
string
);
Constructs a new instance of the Backup
class
Properties
bigtable
bigtable
:
Bigtable
;
cluster
cluster
:
Cluster
;
endDate
get
endDate
()
:
PreciseDate
;
A Date-compatible PreciseDate representing the time that the backup was finished.
{PreciseDate}
expireDate
get
expireDate
()
:
PreciseDate
;
A Date-compatible PreciseDate representing the expiration time of this backup.
{PreciseDate}
id
id
:
string
;
A unique backup string, e.g. "my-backup".
metadata
metadata
?:
IBackup
;
name
name
:
string
;
The full path of the backup which is in the form of: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}
.
startDate
get
startDate
()
:
PreciseDate
;
A Date-compatible PreciseDate representing the time that this backup was started.
{PreciseDate}
Methods
create(config, callback)
create
(
config
:
CreateBackupConfig
,
callback
?:
CreateBackupCallback
)
:
void
;
Returns
Type
Description
void
create(config)
create
(
config
:
CreateBackupConfig
)
:
Promise<CreateBackupResponse>
;
Parameter
Name
Description
config
CreateBackupConfig
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DeleteBackupResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
delete(callback)
delete
(
callback
:
DeleteBackupCallback
)
:
void
;
Returns
Type
Description
void
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DeleteBackupCallback
)
:
void
;
Returns
Type
Description
void
exists(gaxOptions)
exists
(
gaxOptions
?:
CallOptions
)
:
Promise<BackupExistsResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
Returns
Type
Description
Promise
< BackupExistsResponse
>
exists(gaxOptions, callback)
exists
(
gaxOptions
:
CallOptions
,
callback
:
BackupExistsCallback
)
:
void
;
Parameters
Name
Description
gaxOptions
CallOptions
callback
BackupExistsCallback
Returns
Type
Description
void
exists(callback)
exists
(
callback
:
BackupExistsCallback
)
:
void
;
Parameter
Name
Description
callback
BackupExistsCallback
Returns
Type
Description
void
get(gaxOptions)
get
(
gaxOptions
?:
CallOptions
)
:
Promise<GetBackupResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
get(callback)
get
(
callback
:
GetBackupCallback
)
:
void
;
Returns
Type
Description
void
get(gaxOptions, callback)
get
(
gaxOptions
:
CallOptions
,
callback
:
GetBackupCallback
)
:
void
;
Returns
Type
Description
void
getIamPolicy(options)
getIamPolicy
(
options
?:
GetIamPolicyOptions
)
:
Promise<GetIamPolicyResponse>
;
getIamPolicy(options, callback)
getIamPolicy
(
options
:
GetIamPolicyOptions
,
callback
:
GetIamPolicyCallback
)
:
void
;
Returns
Type
Description
void
getMetadata(gaxOptions)
getMetadata
(
gaxOptions
?:
CallOptions
)
:
Promise<BackupGetMetadataResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
getMetadata(callback)
getMetadata
(
callback
:
BackupGetMetadataCallback
)
:
void
;
Returns
Type
Description
void
getMetadata(gaxOptions, callback)
getMetadata
(
gaxOptions
:
CallOptions
,
callback
:
BackupGetMetadataCallback
)
:
void
;
Returns
Type
Description
void
restore(tableId, gaxOptions)
restore
(
tableId
:
string
,
gaxOptions
?:
CallOptions
)
:
Promise<RestoreTableResponse>
;
Parameters
Name
Description
tableId
string
gaxOptions
CallOptions
restore(tableId, gaxOptions, callback)
restore
(
tableId
:
string
,
gaxOptions
:
CallOptions
,
callback
:
RestoreTableCallback
)
:
void
;
Returns
Type
Description
void
restore(tableId, callback)
restore
(
tableId
:
string
,
callback
:
RestoreTableCallback
)
:
void
;
Returns
Type
Description
void
restoreTo(config)
restoreTo
(
config
:
RestoreTableConfig
)
:
Promise<RestoreTableResponse>
;
Parameter
Name
Description
config
RestoreTableConfig
restoreTo(config, callback)
restoreTo
(
config
:
RestoreTableConfig
,
callback
:
RestoreTableCallback
)
:
void
;
Returns
Type
Description
void
setIamPolicy(policy, gaxOptions)
setIamPolicy
(
policy
:
Policy
,
gaxOptions
?:
CallOptions
)
:
Promise<SetIamPolicyResponse>
;
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy
(
policy
:
Policy
,
gaxOptions
:
CallOptions
,
callback
:
SetIamPolicyCallback
)
:
void
;
Returns
Type
Description
void
setIamPolicy(policy, callback)
setIamPolicy
(
policy
:
Policy
,
callback
:
SetIamPolicyCallback
)
:
void
;
Returns
Type
Description
void
setMetadata(metadata, gaxOptions)
setMetadata
(
metadata
:
ModifiableBackupFields
,
gaxOptions
?:
CallOptions
)
:
Promise<BackupSetMetadataResponse>
;
setMetadata(metadata, callback)
setMetadata
(
metadata
:
ModifiableBackupFields
,
callback
:
BackupSetMetadataCallback
)
:
void
;
Returns
Type
Description
void
setMetadata(metadata, gaxOptions, callback)
setMetadata
(
metadata
:
ModifiableBackupFields
,
gaxOptions
:
CallOptions
,
callback
:
BackupSetMetadataCallback
)
:
void
;
Parameters
Name
Description
metadata
gaxOptions
CallOptions
callback
Returns
Type
Description
void
testIamPermissions(permissions, gaxOptions)
testIamPermissions
(
permissions
:
string
|
string
[],
gaxOptions
?:
CallOptions
)
:
Promise<TestIamPermissionsResponse>
;
Parameters
Name
Description
permissions
string | string[]
gaxOptions
CallOptions
testIamPermissions(permissions, callback)
testIamPermissions
(
permissions
:
string
|
string
[],
callback
:
TestIamPermissionsCallback
)
:
void
;
Returns
Type
Description
void
testIamPermissions(permissions, gaxOptions, callback)
testIamPermissions
(
permissions
:
string
|
string
[],
gaxOptions
:
CallOptions
,
callback
:
TestIamPermissionsCallback
)
:
void
;
Parameters
Name
Description
permissions
string | string[]
gaxOptions
CallOptions
callback
Returns
Type
Description
void
