Class Backup (5.1.1)

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

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

copy(config, callback)

copy(config: CopyBackupConfig, callback: CopyBackupCallback): void;

When this backup object represents a backup that has already been created, copy will copy this created backup to the location and with the settings specified by the config parameter. After running this function the original backup will exist as well as a second backup matching the parameters given by the config argument.

Parameters
Name Description
config CopyBackupConfig

The config that specifies all of the information about the destination backup which is the new backup that gets created as a result of calling copy.

callback CopyBackupCallback

The callback function that passes an error or results back to the user.

Returns
Type Description
void

copy(config)

copy(config: CopyBackupConfig): Promise<CopyBackupResponse>;
Parameter
Name Description
config CopyBackupConfig
Returns
Type Description
Promise<CopyBackupResponse>

create(config, callback)

create(config: CreateBackupConfig, callback?: CreateBackupCallback): void;
Parameters
Name Description
config CreateBackupConfig
callback CreateBackupCallback
Returns
Type Description
void

create(config)

create(config: CreateBackupConfig): Promise<CreateBackupResponse>;
Parameter
Name Description
config CreateBackupConfig
Returns
Type Description
Promise<CreateBackupResponse>

delete(gaxOptions)

delete(gaxOptions?: CallOptions): Promise<DeleteBackupResponse>;
Parameter
Name Description
gaxOptions CallOptions
Returns
Type Description
Promise<DeleteBackupResponse>

delete(callback)

delete(callback: DeleteBackupCallback): void;
Parameter
Name Description
callback DeleteBackupCallback
Returns
Type Description
void

delete(gaxOptions, callback)

delete(gaxOptions: CallOptions, callback: DeleteBackupCallback): void;
Parameters
Name Description
gaxOptions CallOptions
callback DeleteBackupCallback
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
Returns
Type Description
Promise<GetBackupResponse>

get(callback)

get(callback: GetBackupCallback): void;
Parameter
Name Description
callback GetBackupCallback
Returns
Type Description
void

get(gaxOptions, callback)

get(gaxOptions: CallOptions, callback: GetBackupCallback): void;
Parameters
Name Description
gaxOptions CallOptions
callback GetBackupCallback
Returns
Type Description
void

getIamPolicy(options)

getIamPolicy(options?: GetIamPolicyOptions): Promise<GetIamPolicyResponse>;
Parameter
Name Description
options GetIamPolicyOptions
Returns
Type Description
Promise<GetIamPolicyResponse>

getIamPolicy(options, callback)

getIamPolicy(options: GetIamPolicyOptions, callback: GetIamPolicyCallback): void;
Parameters
Name Description
options GetIamPolicyOptions
callback GetIamPolicyCallback
Returns
Type Description
void

getMetadata(gaxOptions)

getMetadata(gaxOptions?: CallOptions): Promise<BackupGetMetadataResponse>;
Parameter
Name Description
gaxOptions CallOptions
Returns
Type Description
Promise<BackupGetMetadataResponse>

getMetadata(callback)

getMetadata(callback: BackupGetMetadataCallback): void;
Parameter
Name Description
callback BackupGetMetadataCallback
Returns
Type Description
void

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions: CallOptions, callback: BackupGetMetadataCallback): void;
Parameters
Name Description
gaxOptions CallOptions
callback BackupGetMetadataCallback
Returns
Type Description
void

restore(tableId, gaxOptions)

restore(tableId: string, gaxOptions?: CallOptions): Promise<RestoreTableResponse>;
Parameters
Name Description
tableId string
gaxOptions CallOptions
Returns
Type Description
Promise<RestoreTableResponse>

restore(tableId, gaxOptions, callback)

restore(tableId: string, gaxOptions: CallOptions, callback: RestoreTableCallback): void;
Parameters
Name Description
tableId string
gaxOptions CallOptions
callback RestoreTableCallback
Returns
Type Description
void

restore(tableId, callback)

restore(tableId: string, callback: RestoreTableCallback): void;
Parameters
Name Description
tableId string
callback RestoreTableCallback
Returns
Type Description
void

restoreTo(config)

restoreTo(config: RestoreTableConfig): Promise<RestoreTableResponse>;
Parameter
Name Description
config RestoreTableConfig
Returns
Type Description
Promise<RestoreTableResponse>

restoreTo(config, callback)

restoreTo(config: RestoreTableConfig, callback: RestoreTableCallback): void;
Parameters
Name Description
config RestoreTableConfig
callback RestoreTableCallback
Returns
Type Description
void

setIamPolicy(policy, gaxOptions)

setIamPolicy(policy: Policy, gaxOptions?: CallOptions): Promise<SetIamPolicyResponse>;
Parameters
Name Description
policy Policy
gaxOptions CallOptions
Returns
Type Description
Promise<SetIamPolicyResponse>

setIamPolicy(policy, gaxOptions, callback)

setIamPolicy(policy: Policy, gaxOptions: CallOptions, callback: SetIamPolicyCallback): void;
Parameters
Name Description
policy Policy
gaxOptions CallOptions
callback SetIamPolicyCallback
Returns
Type Description
void

setIamPolicy(policy, callback)

setIamPolicy(policy: Policy, callback: SetIamPolicyCallback): void;
Parameters
Name Description
policy Policy
callback SetIamPolicyCallback
Returns
Type Description
void

setMetadata(metadata, gaxOptions)

setMetadata(metadata: ModifiableBackupFields, gaxOptions?: CallOptions): Promise<BackupSetMetadataResponse>;
Parameters
Name Description
metadata ModifiableBackupFields
gaxOptions CallOptions
Returns
Type Description
Promise<BackupSetMetadataResponse>

setMetadata(metadata, callback)

setMetadata(metadata: ModifiableBackupFields, callback: BackupSetMetadataCallback): void;
Parameters
Name Description
metadata ModifiableBackupFields
callback BackupSetMetadataCallback
Returns
Type Description
void

setMetadata(metadata, gaxOptions, callback)

setMetadata(metadata: ModifiableBackupFields, gaxOptions: CallOptions, callback: BackupSetMetadataCallback): void;
Parameters
Name Description
metadata ModifiableBackupFields
gaxOptions CallOptions
callback BackupSetMetadataCallback
Returns
Type Description
void

testIamPermissions(permissions, gaxOptions)

testIamPermissions(permissions: string | string[], gaxOptions?: CallOptions): Promise<TestIamPermissionsResponse>;
Parameters
Name Description
permissions string | string[]
gaxOptions CallOptions
Returns
Type Description
Promise<TestIamPermissionsResponse>

testIamPermissions(permissions, callback)

testIamPermissions(permissions: string | string[], callback: TestIamPermissionsCallback): void;
Parameters
Name Description
permissions string | string[]
callback TestIamPermissionsCallback
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 TestIamPermissionsCallback
Returns
Type Description
void