Send feedback
Class Backup (3.10.0)
bookmark_border bookmark
Stay organized with collections
Save and categorize content based on your preferences.
On this page Package Example Constructors Properties Methods create(config, callback) create(config) delete(gaxOptions) delete(callback) delete(gaxOptions, callback) exists(gaxOptions) exists(gaxOptions, callback) exists(callback) get(gaxOptions) get(callback) get(gaxOptions, callback) getIamPolicy(options) getIamPolicy(options, callback) getMetadata(gaxOptions) getMetadata(callback) getMetadata(gaxOptions, callback) restore(tableId, gaxOptions) restore(tableId, gaxOptions, callback) restore(tableId, callback) restoreTo(config) restoreTo(config, callback) setIamPolicy(policy, gaxOptions) setIamPolicy(policy, gaxOptions, callback) setIamPolicy(policy, callback) setMetadata(metadata, gaxOptions) setMetadata(metadata, callback) setMetadata(metadata, gaxOptions, callback) testIamPermissions(permissions, gaxOptions) testIamPermissions(permissions, callback) testIamPermissions(permissions, gaxOptions, callback)
Version 3.10.0 keyboard_arrow_down
Interact with backups like get detailed information from BigTable, create a backup, or restore a backup to a table.
Package
@google-cloud/bigtable
Example
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
Parameters
Name Description cluster
Cluster id
string The backup name or id.
Properties
bigtable
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
A unique backup string, e.g. "my-backup".
name
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 ;
Parameters
Returns
create(config)
create ( config : CreateBackupConfig ) : Promise<CreateBackupResponse> ;
Parameter
Name Description config
CreateBackupConfig
Returns
delete(gaxOptions)
delete ( gaxOptions ?: CallOptions ) : Promise<DeleteBackupResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
delete(callback)
delete ( callback : DeleteBackupCallback ) : void ;
Parameter
Returns
delete(gaxOptions, callback)
delete ( gaxOptions : CallOptions , callback : DeleteBackupCallback ) : void ;
Parameters
Returns
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
exists(callback)
exists ( callback : BackupExistsCallback ) : void ;
Parameter
Name Description callback
BackupExistsCallback
Returns
get(gaxOptions)
get ( gaxOptions ?: CallOptions ) : Promise<GetBackupResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
get(callback)
get ( callback : GetBackupCallback ) : void ;
Parameter
Returns
get(gaxOptions, callback)
get ( gaxOptions : CallOptions , callback : GetBackupCallback ) : void ;
Parameters
Returns
getIamPolicy(options)
getIamPolicy ( options ?: GetIamPolicyOptions ) : Promise<GetIamPolicyResponse> ;
Parameter
Returns
getIamPolicy(options, callback)
getIamPolicy ( options : GetIamPolicyOptions , callback : GetIamPolicyCallback ) : void ;
Parameters
Returns
getMetadata ( gaxOptions ?: CallOptions ) : Promise<BackupGetMetadataResponse> ;
Parameter
Name Description gaxOptions
CallOptions
Returns
getMetadata ( callback : BackupGetMetadataCallback ) : void ;
Parameter
Returns
getMetadata ( gaxOptions : CallOptions , callback : BackupGetMetadataCallback ) : void ;
Parameters
Returns
restore(tableId, gaxOptions)
restore ( tableId : string , gaxOptions ?: CallOptions ) : Promise<RestoreTableResponse> ;
Parameters
Name Description tableId
string gaxOptions
CallOptions
Returns
restore(tableId, gaxOptions, callback)
restore ( tableId : string , gaxOptions : CallOptions , callback : RestoreTableCallback ) : void ;
Parameters
Returns
restore(tableId, callback)
restore ( tableId : string , callback : RestoreTableCallback ) : void ;
Parameters
Returns
restoreTo(config)
restoreTo ( config : RestoreTableConfig ) : Promise<RestoreTableResponse> ;
Parameter
Name Description config
RestoreTableConfig
Returns
restoreTo(config, callback)
restoreTo ( config : RestoreTableConfig , callback : RestoreTableCallback ) : void ;
Parameters
Returns
setIamPolicy(policy, gaxOptions)
setIamPolicy ( policy : Policy , gaxOptions ?: CallOptions ) : Promise<SetIamPolicyResponse> ;
Parameters
Name Description policy
Policy gaxOptions
CallOptions
Returns
setIamPolicy(policy, gaxOptions, callback)
setIamPolicy ( policy : Policy , gaxOptions : CallOptions , callback : SetIamPolicyCallback ) : void ;
Parameters
Returns
setIamPolicy(policy, callback)
setIamPolicy ( policy : Policy , callback : SetIamPolicyCallback ) : void ;
Parameters
Returns
setMetadata ( metadata : ModifiableBackupFields , gaxOptions ?: CallOptions ) : Promise<BackupSetMetadataResponse> ;
Parameters
Returns
setMetadata ( metadata : ModifiableBackupFields , callback : BackupSetMetadataCallback ) : void ;
Parameters
Returns
setMetadata ( metadata : ModifiableBackupFields , gaxOptions : CallOptions , callback : BackupSetMetadataCallback ) : void ;
Parameters
Returns
testIamPermissions(permissions, gaxOptions)
testIamPermissions ( permissions : string | string [], gaxOptions ?: CallOptions ) : Promise<TestIamPermissionsResponse> ;
Parameters
Name Description permissions
string | string[] gaxOptions
CallOptions
Returns
testIamPermissions(permissions, callback)
testIamPermissions ( permissions : string | string [], callback : TestIamPermissionsCallback ) : void ;
Parameters
Returns
testIamPermissions(permissions, gaxOptions, callback)
testIamPermissions ( permissions : string | string [], gaxOptions : CallOptions , callback : TestIamPermissionsCallback ) : void ;
Parameters
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[],[]]
