Class Backup

The Backup class represents a Cloud Spanner backup.

Create a Backup object to interact with or create a Cloud Spanner backup.

Package

@google-cloud/spanner!

Constructors

(constructor)(instance, name)

constructor(instance: Instance, name: string);

Constructs a new instance of the Backup class

Parameters
TypeNameDescription
Instanceinstance
stringname

Properties

formattedName_

formattedName_: string;
Property Value
TypeDescription
string

id

id: string;
Property Value
TypeDescription
string

instanceFormattedName_

instanceFormattedName_: string;
Property Value
TypeDescription
string

metadata

metadata?: databaseAdmin.spanner.admin.database.v1.IBackup;
Property Value
TypeDescription
databaseAdmin.spanner.admin.database.v1.IBackup

request

request: BackupRequest;
Property Value
TypeDescription
BackupRequest

resourceHeader_

resourceHeader_: {
        [k: string]: string;
    };
Property Value
TypeDescription
{ [k: string]: string; }

Methods

create(options)

create(options: CreateBackupOptions): Promise<CreateBackupResponse>;
Parameter
TypeNameDescription
CreateBackupOptionsoptions
Returns
TypeDescription
Promise<CreateBackupResponse>

create(options, callback)

create(options: CreateBackupOptions, callback: CreateBackupCallback): void;
Parameters
TypeNameDescription
CreateBackupOptionsoptions
CreateBackupCallbackcallback
Returns
TypeDescription
void

delete(gaxOptions)

delete(gaxOptions?: CallOptions): Promise<databaseAdmin.protobuf.IEmpty>;
Parameter
TypeNameDescription
CallOptionsgaxOptions
Returns
TypeDescription
Promise<google.protobuf.IEmpty>

delete(callback)

delete(callback: DeleteCallback): void;
Parameter
TypeNameDescription
DeleteCallbackcallback
Returns
TypeDescription
void

delete(gaxOptions, callback)

delete(gaxOptions: CallOptions, callback: DeleteCallback): void;
Parameters
TypeNameDescription
CallOptionsgaxOptions
DeleteCallbackcallback
Returns
TypeDescription
void

exists()

exists(): Promise<boolean>;
Returns
TypeDescription
Promise<boolean>

exists(callback)

exists(callback: ExistsCallback): void;
Parameter
TypeNameDescription
ExistsCallbackcallback
Returns
TypeDescription
void

formatName_(instanceName, name)

static formatName_(instanceName: string, name: string): string;

Format the backup name to include the instance name.

Parameters
TypeNameDescription
stringinstanceName

The formatted instance name.

stringname

The table name.

Returns
TypeDescription
string

{string}

getExpireTime()

getExpireTime(): Promise<PreciseDate | undefined>;
Returns
TypeDescription
Promise<PreciseDate | undefined>

getExpireTime(callback)

getExpireTime(callback: GetExpireTimeCallback): void;
Parameter
TypeNameDescription
GetExpireTimeCallbackcallback
Returns
TypeDescription
void

getMetadata(gaxOptions)

getMetadata(gaxOptions?: CallOptions): Promise<GetMetadataResponse>;
Parameter
TypeNameDescription
CallOptionsgaxOptions
Returns
TypeDescription
Promise<GetMetadataResponse>

getMetadata(callback)

getMetadata(callback: GetMetadataCallback): void;
Parameter
TypeNameDescription
GetMetadataCallbackcallback
Returns
TypeDescription
void

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions: CallOptions, callback: GetMetadataCallback): void;
Parameters
TypeNameDescription
CallOptionsgaxOptions
GetMetadataCallbackcallback
Returns
TypeDescription
void

getState()

getState(): Promise<EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State> | undefined | null>;
Returns
TypeDescription
Promise<EnumKey<typeof google.spanner.admin.database.v1.Backup.State> | undefined | null>

getState(callback)

getState(callback: GetStateCallback): void;
Parameter
TypeNameDescription
GetStateCallbackcallback
Returns
TypeDescription
void

updateExpireTime(expireTime)

updateExpireTime(expireTime: string | number | p.ITimestamp | PreciseDate): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
Parameter
TypeNameDescription
string | number | common.ITimestamp | PreciseDateexpireTime
Returns
TypeDescription
Promise<google.spanner.admin.database.v1.IBackup>

updateExpireTime(expireTime, gaxOptions)

updateExpireTime(expireTime: string | number | p.ITimestamp | PreciseDate, gaxOptions?: CallOptions): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
Parameters
TypeNameDescription
string | number | common.ITimestamp | PreciseDateexpireTime
CallOptionsgaxOptions
Returns
TypeDescription
Promise<google.spanner.admin.database.v1.IBackup>

updateExpireTime(expireTime, callback)

updateExpireTime(expireTime: string | number | p.ITimestamp | PreciseDate, callback: UpdateExpireTimeCallback): void;
Parameters
TypeNameDescription
string | number | common.ITimestamp | PreciseDateexpireTime
UpdateExpireTimeCallbackcallback
Returns
TypeDescription
void

updateExpireTime(expireTime, gaxOptions, callback)

updateExpireTime(expireTime: string | number | p.ITimestamp | PreciseDate, gaxOptions: CallOptions, callback: UpdateExpireTimeCallback): void;
Parameters
TypeNameDescription
string | number | common.ITimestamp | PreciseDateexpireTime
CallOptionsgaxOptions
UpdateExpireTimeCallbackcallback
Returns
TypeDescription
void