Class protos.google.cloud.gkebackup.v1.BackupForGKE (1.3.0)

Version latest

• 1.3.0 (latest)
• 1.0.0
• 0.3.2
• 0.2.2

Represents a BackupForGKE

Inheritance

$protobuf.rpc.Service > protos.google.cloud.gkebackup.v1.BackupForGKE

Package

@google-cloud/gke-backup

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BackupForGKE service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BackupForGKE;

Creates new BackupForGKE service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
BackupForGKE	RPC service. Useful where requests and/or responses are streamed.

createBackup(request, callback)

public createBackup(request: google.cloud.gkebackup.v1.ICreateBackupRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.CreateBackupCallback): void;

Calls CreateBackup.

Parameters
Name	Description
request	ICreateBackupRequest CreateBackupRequest message or plain object
callback	CreateBackupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createBackup(request)

public createBackup(request: google.cloud.gkebackup.v1.ICreateBackupRequest): Promise<google.longrunning.Operation>;

Calls CreateBackup.

Parameter
Name	Description
request	ICreateBackupRequest CreateBackupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createBackupPlan(request, callback)

public createBackupPlan(request: google.cloud.gkebackup.v1.ICreateBackupPlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.CreateBackupPlanCallback): void;

Calls CreateBackupPlan.

Parameters
Name	Description
request	ICreateBackupPlanRequest CreateBackupPlanRequest message or plain object
callback	CreateBackupPlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createBackupPlan(request)

public createBackupPlan(request: google.cloud.gkebackup.v1.ICreateBackupPlanRequest): Promise<google.longrunning.Operation>;

Calls CreateBackupPlan.

Parameter
Name	Description
request	ICreateBackupPlanRequest CreateBackupPlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createRestore(request, callback)

public createRestore(request: google.cloud.gkebackup.v1.ICreateRestoreRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.CreateRestoreCallback): void;

Calls CreateRestore.

Parameters
Name	Description
request	ICreateRestoreRequest CreateRestoreRequest message or plain object
callback	CreateRestoreCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createRestore(request)

public createRestore(request: google.cloud.gkebackup.v1.ICreateRestoreRequest): Promise<google.longrunning.Operation>;

Calls CreateRestore.

Parameter
Name	Description
request	ICreateRestoreRequest CreateRestoreRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createRestorePlan(request, callback)

public createRestorePlan(request: google.cloud.gkebackup.v1.ICreateRestorePlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.CreateRestorePlanCallback): void;

Calls CreateRestorePlan.

Parameters
Name	Description
request	ICreateRestorePlanRequest CreateRestorePlanRequest message or plain object
callback	CreateRestorePlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createRestorePlan(request)

public createRestorePlan(request: google.cloud.gkebackup.v1.ICreateRestorePlanRequest): Promise<google.longrunning.Operation>;

Calls CreateRestorePlan.

Parameter
Name	Description
request	ICreateRestorePlanRequest CreateRestorePlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteBackup(request, callback)

public deleteBackup(request: google.cloud.gkebackup.v1.IDeleteBackupRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.DeleteBackupCallback): void;

Calls DeleteBackup.

Parameters
Name	Description
request	IDeleteBackupRequest DeleteBackupRequest message or plain object
callback	DeleteBackupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteBackup(request)

public deleteBackup(request: google.cloud.gkebackup.v1.IDeleteBackupRequest): Promise<google.longrunning.Operation>;

Calls DeleteBackup.

Parameter
Name	Description
request	IDeleteBackupRequest DeleteBackupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteBackupPlan(request, callback)

public deleteBackupPlan(request: google.cloud.gkebackup.v1.IDeleteBackupPlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.DeleteBackupPlanCallback): void;

Calls DeleteBackupPlan.

Parameters
Name	Description
request	IDeleteBackupPlanRequest DeleteBackupPlanRequest message or plain object
callback	DeleteBackupPlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteBackupPlan(request)

public deleteBackupPlan(request: google.cloud.gkebackup.v1.IDeleteBackupPlanRequest): Promise<google.longrunning.Operation>;

Calls DeleteBackupPlan.

Parameter
Name	Description
request	IDeleteBackupPlanRequest DeleteBackupPlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteRestore(request, callback)

public deleteRestore(request: google.cloud.gkebackup.v1.IDeleteRestoreRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.DeleteRestoreCallback): void;

Calls DeleteRestore.

Parameters
Name	Description
request	IDeleteRestoreRequest DeleteRestoreRequest message or plain object
callback	DeleteRestoreCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteRestore(request)

public deleteRestore(request: google.cloud.gkebackup.v1.IDeleteRestoreRequest): Promise<google.longrunning.Operation>;

Calls DeleteRestore.

Parameter
Name	Description
request	IDeleteRestoreRequest DeleteRestoreRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteRestorePlan(request, callback)

public deleteRestorePlan(request: google.cloud.gkebackup.v1.IDeleteRestorePlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.DeleteRestorePlanCallback): void;

Calls DeleteRestorePlan.

Parameters
Name	Description
request	IDeleteRestorePlanRequest DeleteRestorePlanRequest message or plain object
callback	DeleteRestorePlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteRestorePlan(request)

public deleteRestorePlan(request: google.cloud.gkebackup.v1.IDeleteRestorePlanRequest): Promise<google.longrunning.Operation>;

Calls DeleteRestorePlan.

Parameter
Name	Description
request	IDeleteRestorePlanRequest DeleteRestorePlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getBackup(request, callback)

public getBackup(request: google.cloud.gkebackup.v1.IGetBackupRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetBackupCallback): void;

Calls GetBackup.

Parameters
Name	Description
request	IGetBackupRequest GetBackupRequest message or plain object
callback	GetBackupCallback Node-style callback called with the error, if any, and Backup

Returns
Type	Description
void

getBackup(request)

public getBackup(request: google.cloud.gkebackup.v1.IGetBackupRequest): Promise<google.cloud.gkebackup.v1.Backup>;

Calls GetBackup.

Parameter
Name	Description
request	IGetBackupRequest GetBackupRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.Backup>	Promise

getBackupIndexDownloadUrl(request, callback)

public getBackupIndexDownloadUrl(request: google.cloud.gkebackup.v1.IGetBackupIndexDownloadUrlRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetBackupIndexDownloadUrlCallback): void;

Calls GetBackupIndexDownloadUrl.

Parameters
Name	Description
request	IGetBackupIndexDownloadUrlRequest GetBackupIndexDownloadUrlRequest message or plain object
callback	GetBackupIndexDownloadUrlCallback Node-style callback called with the error, if any, and GetBackupIndexDownloadUrlResponse

Returns
Type	Description
void

getBackupIndexDownloadUrl(request)

public getBackupIndexDownloadUrl(request: google.cloud.gkebackup.v1.IGetBackupIndexDownloadUrlRequest): Promise<google.cloud.gkebackup.v1.GetBackupIndexDownloadUrlResponse>;

Calls GetBackupIndexDownloadUrl.

Parameter
Name	Description
request	IGetBackupIndexDownloadUrlRequest GetBackupIndexDownloadUrlRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.GetBackupIndexDownloadUrlResponse>	Promise

getBackupPlan(request, callback)

public getBackupPlan(request: google.cloud.gkebackup.v1.IGetBackupPlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetBackupPlanCallback): void;

Calls GetBackupPlan.

Parameters
Name	Description
request	IGetBackupPlanRequest GetBackupPlanRequest message or plain object
callback	GetBackupPlanCallback Node-style callback called with the error, if any, and BackupPlan

Returns
Type	Description
void

getBackupPlan(request)

public getBackupPlan(request: google.cloud.gkebackup.v1.IGetBackupPlanRequest): Promise<google.cloud.gkebackup.v1.BackupPlan>;

Calls GetBackupPlan.

Parameter
Name	Description
request	IGetBackupPlanRequest GetBackupPlanRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.BackupPlan>	Promise

getRestore(request, callback)

public getRestore(request: google.cloud.gkebackup.v1.IGetRestoreRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetRestoreCallback): void;

Calls GetRestore.

Parameters
Name	Description
request	IGetRestoreRequest GetRestoreRequest message or plain object
callback	GetRestoreCallback Node-style callback called with the error, if any, and Restore

Returns
Type	Description
void

getRestore(request)

public getRestore(request: google.cloud.gkebackup.v1.IGetRestoreRequest): Promise<google.cloud.gkebackup.v1.Restore>;

Calls GetRestore.

Parameter
Name	Description
request	IGetRestoreRequest GetRestoreRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.Restore>	Promise

getRestorePlan(request, callback)

public getRestorePlan(request: google.cloud.gkebackup.v1.IGetRestorePlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetRestorePlanCallback): void;

Calls GetRestorePlan.

Parameters
Name	Description
request	IGetRestorePlanRequest GetRestorePlanRequest message or plain object
callback	GetRestorePlanCallback Node-style callback called with the error, if any, and RestorePlan

Returns
Type	Description
void

getRestorePlan(request)

public getRestorePlan(request: google.cloud.gkebackup.v1.IGetRestorePlanRequest): Promise<google.cloud.gkebackup.v1.RestorePlan>;

Calls GetRestorePlan.

Parameter
Name	Description
request	IGetRestorePlanRequest GetRestorePlanRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.RestorePlan>	Promise

getVolumeBackup(request, callback)

public getVolumeBackup(request: google.cloud.gkebackup.v1.IGetVolumeBackupRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetVolumeBackupCallback): void;

Calls GetVolumeBackup.

Parameters
Name	Description
request	IGetVolumeBackupRequest GetVolumeBackupRequest message or plain object
callback	GetVolumeBackupCallback Node-style callback called with the error, if any, and VolumeBackup

Returns
Type	Description
void

getVolumeBackup(request)

public getVolumeBackup(request: google.cloud.gkebackup.v1.IGetVolumeBackupRequest): Promise<google.cloud.gkebackup.v1.VolumeBackup>;

Calls GetVolumeBackup.

Parameter
Name	Description
request	IGetVolumeBackupRequest GetVolumeBackupRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.VolumeBackup>	Promise

getVolumeRestore(request, callback)

public getVolumeRestore(request: google.cloud.gkebackup.v1.IGetVolumeRestoreRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.GetVolumeRestoreCallback): void;

Calls GetVolumeRestore.

Parameters
Name	Description
request	IGetVolumeRestoreRequest GetVolumeRestoreRequest message or plain object
callback	GetVolumeRestoreCallback Node-style callback called with the error, if any, and VolumeRestore

Returns
Type	Description
void

getVolumeRestore(request)

public getVolumeRestore(request: google.cloud.gkebackup.v1.IGetVolumeRestoreRequest): Promise<google.cloud.gkebackup.v1.VolumeRestore>;

Calls GetVolumeRestore.

Parameter
Name	Description
request	IGetVolumeRestoreRequest GetVolumeRestoreRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.VolumeRestore>	Promise

listBackupPlans(request, callback)

public listBackupPlans(request: google.cloud.gkebackup.v1.IListBackupPlansRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListBackupPlansCallback): void;

Calls ListBackupPlans.

Parameters
Name	Description
request	IListBackupPlansRequest ListBackupPlansRequest message or plain object
callback	ListBackupPlansCallback Node-style callback called with the error, if any, and ListBackupPlansResponse

Returns
Type	Description
void

listBackupPlans(request)

public listBackupPlans(request: google.cloud.gkebackup.v1.IListBackupPlansRequest): Promise<google.cloud.gkebackup.v1.ListBackupPlansResponse>;

Calls ListBackupPlans.

Parameter
Name	Description
request	IListBackupPlansRequest ListBackupPlansRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListBackupPlansResponse>	Promise

listBackups(request, callback)

public listBackups(request: google.cloud.gkebackup.v1.IListBackupsRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListBackupsCallback): void;

Calls ListBackups.

Parameters
Name	Description
request	IListBackupsRequest ListBackupsRequest message or plain object
callback	ListBackupsCallback Node-style callback called with the error, if any, and ListBackupsResponse

Returns
Type	Description
void

listBackups(request)

public listBackups(request: google.cloud.gkebackup.v1.IListBackupsRequest): Promise<google.cloud.gkebackup.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name	Description
request	IListBackupsRequest ListBackupsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListBackupsResponse>	Promise

listRestorePlans(request, callback)

public listRestorePlans(request: google.cloud.gkebackup.v1.IListRestorePlansRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListRestorePlansCallback): void;

Calls ListRestorePlans.

Parameters
Name	Description
request	IListRestorePlansRequest ListRestorePlansRequest message or plain object
callback	ListRestorePlansCallback Node-style callback called with the error, if any, and ListRestorePlansResponse

Returns
Type	Description
void

listRestorePlans(request)

public listRestorePlans(request: google.cloud.gkebackup.v1.IListRestorePlansRequest): Promise<google.cloud.gkebackup.v1.ListRestorePlansResponse>;

Calls ListRestorePlans.

Parameter
Name	Description
request	IListRestorePlansRequest ListRestorePlansRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListRestorePlansResponse>	Promise

listRestores(request, callback)

public listRestores(request: google.cloud.gkebackup.v1.IListRestoresRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListRestoresCallback): void;

Calls ListRestores.

Parameters
Name	Description
request	IListRestoresRequest ListRestoresRequest message or plain object
callback	ListRestoresCallback Node-style callback called with the error, if any, and ListRestoresResponse

Returns
Type	Description
void

listRestores(request)

public listRestores(request: google.cloud.gkebackup.v1.IListRestoresRequest): Promise<google.cloud.gkebackup.v1.ListRestoresResponse>;

Calls ListRestores.

Parameter
Name	Description
request	IListRestoresRequest ListRestoresRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListRestoresResponse>	Promise

listVolumeBackups(request, callback)

public listVolumeBackups(request: google.cloud.gkebackup.v1.IListVolumeBackupsRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListVolumeBackupsCallback): void;

Calls ListVolumeBackups.

Parameters
Name	Description
request	IListVolumeBackupsRequest ListVolumeBackupsRequest message or plain object
callback	ListVolumeBackupsCallback Node-style callback called with the error, if any, and ListVolumeBackupsResponse

Returns
Type	Description
void

listVolumeBackups(request)

public listVolumeBackups(request: google.cloud.gkebackup.v1.IListVolumeBackupsRequest): Promise<google.cloud.gkebackup.v1.ListVolumeBackupsResponse>;

Calls ListVolumeBackups.

Parameter
Name	Description
request	IListVolumeBackupsRequest ListVolumeBackupsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListVolumeBackupsResponse>	Promise

listVolumeRestores(request, callback)

public listVolumeRestores(request: google.cloud.gkebackup.v1.IListVolumeRestoresRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.ListVolumeRestoresCallback): void;

Calls ListVolumeRestores.

Parameters
Name	Description
request	IListVolumeRestoresRequest ListVolumeRestoresRequest message or plain object
callback	ListVolumeRestoresCallback Node-style callback called with the error, if any, and ListVolumeRestoresResponse

Returns
Type	Description
void

listVolumeRestores(request)

public listVolumeRestores(request: google.cloud.gkebackup.v1.IListVolumeRestoresRequest): Promise<google.cloud.gkebackup.v1.ListVolumeRestoresResponse>;

Calls ListVolumeRestores.

Parameter
Name	Description
request	IListVolumeRestoresRequest ListVolumeRestoresRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gkebackup.v1.ListVolumeRestoresResponse>	Promise

updateBackup(request, callback)

public updateBackup(request: google.cloud.gkebackup.v1.IUpdateBackupRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.UpdateBackupCallback): void;

Calls UpdateBackup.

Parameters
Name	Description
request	IUpdateBackupRequest UpdateBackupRequest message or plain object
callback	UpdateBackupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateBackup(request)

public updateBackup(request: google.cloud.gkebackup.v1.IUpdateBackupRequest): Promise<google.longrunning.Operation>;

Calls UpdateBackup.

Parameter
Name	Description
request	IUpdateBackupRequest UpdateBackupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateBackupPlan(request, callback)

public updateBackupPlan(request: google.cloud.gkebackup.v1.IUpdateBackupPlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.UpdateBackupPlanCallback): void;

Calls UpdateBackupPlan.

Parameters
Name	Description
request	IUpdateBackupPlanRequest UpdateBackupPlanRequest message or plain object
callback	UpdateBackupPlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateBackupPlan(request)

public updateBackupPlan(request: google.cloud.gkebackup.v1.IUpdateBackupPlanRequest): Promise<google.longrunning.Operation>;

Calls UpdateBackupPlan.

Parameter
Name	Description
request	IUpdateBackupPlanRequest UpdateBackupPlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateRestore(request, callback)

public updateRestore(request: google.cloud.gkebackup.v1.IUpdateRestoreRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.UpdateRestoreCallback): void;

Calls UpdateRestore.

Parameters
Name	Description
request	IUpdateRestoreRequest UpdateRestoreRequest message or plain object
callback	UpdateRestoreCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateRestore(request)

public updateRestore(request: google.cloud.gkebackup.v1.IUpdateRestoreRequest): Promise<google.longrunning.Operation>;

Calls UpdateRestore.

Parameter
Name	Description
request	IUpdateRestoreRequest UpdateRestoreRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateRestorePlan(request, callback)

public updateRestorePlan(request: google.cloud.gkebackup.v1.IUpdateRestorePlanRequest, callback: google.cloud.gkebackup.v1.BackupForGKE.UpdateRestorePlanCallback): void;

Calls UpdateRestorePlan.

Parameters
Name	Description
request	IUpdateRestorePlanRequest UpdateRestorePlanRequest message or plain object
callback	UpdateRestorePlanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateRestorePlan(request)

public updateRestorePlan(request: google.cloud.gkebackup.v1.IUpdateRestorePlanRequest): Promise<google.longrunning.Operation>;

Calls UpdateRestorePlan.

Parameter
Name	Description
request	IUpdateRestorePlanRequest UpdateRestorePlanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise